diff --git a/_klipper3d/README b/_klipper3d/README deleted file mode 100644 index df91f2d9f..000000000 --- a/_klipper3d/README +++ /dev/null @@ -1,20 +0,0 @@ -This directory defines the https://www.klipper3d.org/ website. The -site is hosted using "github pages". The -.github/workflows/klipper3d-deploy.yaml tool uses mkdocs ( -https://www.mkdocs.org/ ) to automatically convert the markdown files -in the docs/ directory to html. In addition to the files in this -directory, the docs/CNAME file also controls the website generation. - -To test deploy the main English site locally one can use commands -similar to the following: - -virtualenv ~/mkdocs-env && ~/mkdocs-env/bin/pip install -r ~/klipper/docs/_klipper3d/mkdocs-requirements.txt -cd ~/klipper && ~/mkdocs-env/bin/mkdocs serve --config-file ~/klipper/docs/_klipper3d/mkdocs.yml -a 0.0.0.0:8000 - -To test deploy the multi-language site locally one can use commands -similar to the following: - -virtualenv ~/mkdocs-env && ~/mkdocs-env/bin/pip install -r ~/klipper/docs/_klipper3d/mkdocs-requirements.txt -source ~/mkdocs-env/bin/activate -cd ~/klipper && ./docs/_klipper3d/build-translations.sh -cd ~/klipper/site/ && python3 -m http.server 8000 diff --git a/_klipper3d/__pycache__/mkdocs_hooks.cpython-38.pyc b/_klipper3d/__pycache__/mkdocs_hooks.cpython-38.pyc deleted file mode 100644 index 221e8754c..000000000 Binary files a/_klipper3d/__pycache__/mkdocs_hooks.cpython-38.pyc and /dev/null differ diff --git a/_klipper3d/build-translations.sh b/_klipper3d/build-translations.sh deleted file mode 100644 index 4a0117c24..000000000 --- a/_klipper3d/build-translations.sh +++ /dev/null @@ -1,84 +0,0 @@ -#!/bin/bash -# This script extracts the Klipper translations and builds multiple -# mdocs sites - one for each supported language. See the README file -# for additional details. - -MKDOCS_DIR="docs/_klipper3d/" -WORK_DIR="work/" -TRANS_DIR="${WORK_DIR}klipper-translations/" -TRANS_FILE="${TRANS_DIR}active_translations" -MKDOCS_MAIN="${MKDOCS_DIR}mkdocs-main.yml" - -# Fetch translations -git clone --depth 1 https://github.com/Klipper3d/klipper-translations ${TRANS_DIR} - -# Create new mkdocs-main.yml with language links -cp ${MKDOCS_DIR}mkdocs.yml ${MKDOCS_MAIN} -while IFS="," read dirname langsite langdesc langsearch; do - sed -i "s%^.*# Alternate language links automatically added here$% - name: ${langdesc}\n link: /${langsite}/\n lang: ${langsite}\n\0%" ${MKDOCS_MAIN} -done < <(egrep -v '^ *(#|$)' ${TRANS_FILE}) - -# Build main English website -echo "building site for en" -mkdocs build -f ${MKDOCS_MAIN} - -# Build each additional language website -while IFS="," read dirname langsite langdesc langsearch; do - new_docs_dir="${WORK_DIR}lang/${langsite}/docs/" - locale_dir="${TRANS_DIR}/docs/locales/${dirname}" - - # read toc - title=$(sed -n '1p' ${locale_dir}/Navigation.md) - installation_and_configuration=$(sed -n '3p' ${locale_dir}/Navigation.md) - configuration_reference=$(sed -n '5p' ${locale_dir}/Navigation.md) - bed_level=$(sed -n '7p' ${locale_dir}/Navigation.md) - resonance_compensation=$(sed -n '9p' ${locale_dir}/Navigation.md) - command_template=$(sed -n '11p' ${locale_dir}/Navigation.md) - developer_documentation=$(sed -n '13p' ${locale_dir}/Navigation.md) - device_specific_documents=$(sed -n '15p' ${locale_dir}/Navigation.md) - - # Copy markdown files to new_docs_dir - echo "Copying $dirname to $langsite" - mkdir -p "${new_docs_dir}" - cp "${locale_dir}"/*.md "${new_docs_dir}" - echo "copy resources" - cp -r docs/img "${new_docs_dir}" - cp -r docs/prints "${new_docs_dir}" - cp -r docs/_klipper3d "${new_docs_dir}" - - # manually replace index.md if a manual-index.md exist - manual_index="${new_docs_dir}manual-index.md" - if [[ -f "${manual_index}" ]]; then - mv -f "${manual_index}" "${new_docs_dir}index.md" - echo "replaced index.md with manual_index.md for $langsite" - else - echo "Manually translated index file for $langsite not found!" - fi - - # Create language specific mkdocs-lang-xxx.yml file - echo "create language specific mkdocs configurations for ${langsite}" - new_mkdocs_file="${new_docs_dir}_klipper3d/mkdocs-lang-${langsite}.yml" - cp "${MKDOCS_MAIN}" "${new_mkdocs_file}" - - echo "replace search language" - sed -i "s%^ lang: en$% lang: ${langsearch}%" "${new_mkdocs_file}" - - echo "replace site language" - sed -i "s%^ language: en$% language: ${langsite}%" "${new_mkdocs_file}" - - echo "replace toc" - sed -i "s%Klipper documentation$%${title}%" "${new_mkdocs_file}" - sed -i "s%Installation and Configuration:$%${installation_and_configuration}:%" "${new_mkdocs_file}" - sed -i "s%Configuration Reference:$%${configuration_reference}:%" "${new_mkdocs_file}" - sed -i "s%Bed Level:$%${bed_level}:%" "${new_mkdocs_file}" - sed -i "s%Resonance Compensation:$%${resonance_compensation}:%" "${new_mkdocs_file}" - sed -i "s%Command templates:$%${command_template}:%" "${new_mkdocs_file}" - sed -i "s%Developer Documentation:$%${developer_documentation}:%" "${new_mkdocs_file}" - sed -i "s%Device Specific Documents:$%${device_specific_documents}:%" "${new_mkdocs_file}" - - # Build site - echo "building site for ${langsite}" - mkdir -p "${PWD}/site/${langsite}/" - ln -sf "${PWD}/site/${langsite}/" "${WORK_DIR}lang/${langsite}/site" - mkdocs build -f "${new_mkdocs_file}" -done < <(egrep -v '^ *(#|$)' ${TRANS_FILE}) diff --git a/_klipper3d/css/extra.css b/_klipper3d/css/extra.css deleted file mode 100644 index ea57721b0..000000000 --- a/_klipper3d/css/extra.css +++ /dev/null @@ -1,16 +0,0 @@ -/* Customization of mkdocs generated site */ -[data-md-color-scheme="slate"] { - --md-primary-fg-color: hsla(var(--md-hue),15%,12%,1); - --md-default-bg-color: hsla(var(--md-hue),17%,17%,1); - --md-typeset-a-color: steelblue; - --md-accent-fg-color: lightblue; -} - -img { - background-color: white; -} - -.center-image { - margin: 0 auto; - display: block; -} diff --git a/_klipper3d/mkdocs-main.yml b/_klipper3d/mkdocs-main.yml deleted file mode 100644 index 896865dd1..000000000 --- a/_klipper3d/mkdocs-main.yml +++ /dev/null @@ -1,160 +0,0 @@ -# Main configuration file for mkdocs generation of klipper3d.org website - -# Note that the build-translations.sh script expects a certain file -# layout. See that script and the README file for more details. - -# Site and directory configuration -site_name: Klipper documentation -repo_url: https://github.com/Klipper3d/klipper -repo_name: Klipper3d/klipper -edit_uri: blob/master/docs/ -use_directory_urls: False -docs_dir: '../' -site_dir: '../../site/' - -# Custom markdown dialect settings -markdown_extensions: - - toc: - permalink: True - toc_depth: 6 - - attr_list - - mdx_partial_gfm - - mdx_truly_sane_lists - - mdx_breakless_lists -plugins: - search: - lang: en - mkdocs-simple-hooks: - hooks: - on_page_markdown: "docs._klipper3d.mkdocs_hooks:transform" - exclude: - glob: "README.md" - -# Website layout configuration (using mkdocs-material theme) -theme: - name: material - palette: - - media: "(prefers-color-scheme: light)" - scheme: default - primary: white - accent: blue - toggle: - icon: material/lightbulb - name: Switch to dark mode - - media: "(prefers-color-scheme: dark)" - scheme: slate - primary: grey - accent: light blue - toggle: - icon: material/lightbulb-outline - name: Switch to light mode - logo: img/klipper.svg - favicon: img/favicon.ico - icon: - repo: fontawesome/brands/github - alternate: material/web - features: - #- navigation.tabs - #- navigation.expand - - navigation.top - # if enabled, the TOC doesn't work for some pages - # - toc.integrate - - search.suggest - - search.highlight - - search.share - language: en -extra_css: - - _klipper3d/css/extra.css - -# Site usage statistics -extra: - # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#site-search-tracking - analytics: - provider: google - property: G-VEN1PGNQL4 - # Language Selection - alternate: - - name: English - link: / - lang: en - - name: 简体中文 - link: /zh/ - lang: zh - - name: 繁體中文 - link: /zh-Hant/ - lang: zh-Hant - - name: Magyar - link: /hu/ - lang: hu - - name: Italiano - link: /it/ - lang: it - - name: Français - link: /fr/ - lang: fr - # Alternate language links automatically added here - -# Navigation hierarchy (this should mimic the layout of Overview.md) -nav: - - Overview.md - - Features.md - - FAQ.md - - Releases.md - - Config_Changes.md - - Contact.md - - Installation and Configuration: - - Installation: - - Installation.md - - OctoPrint.md - - Configuration Reference: - - Config_Reference.md - - Rotation_Distance.md - - Config_checks.md - - Bed Level: - - Bed_Level.md - - Delta_Calibrate.md - - Probe_Calibrate.md - - BLTouch.md - - Manual_Level.md - - Bed_Mesh.md - - Endstop_Phase.md - - Axis_Twist_Compensation.md - - Resonance Compensation: - - Resonance_Compensation.md - - Measuring_Resonances.md - - Pressure_Advance.md - - G-Codes.md - - Command templates: - - Command_Templates.md - - Status_Reference.md - - TMC_Drivers.md - - Multi_MCU_Homing.md - - Slicers.md - - Skew_Correction.md - - Exclude_Object.md - - Using_PWM_Tools.md - - Developer Documentation: - - Code_Overview.md - - Kinematics.md - - Protocol.md - - API_Server.md - - MCU_Commands.md - - CANBUS_protocol.md - - Debugging.md - - Benchmarks.md - - CONTRIBUTING.md - - Packaging.md - - Device Specific Documents: - - Example_Configs.md - - SDCard_Updates.md - - RPi_microcontroller.md - - Beaglebone.md - - Bootloaders.md - - Bootloader_Entry.md - - CANBUS.md - - CANBUS_Troubleshooting.md - - TSL1401CL_Filament_Width_Sensor.md - - Hall_Filament_Width_Sensor.md - - Eddy_Probe.md - - Load_Cell.md - - Sponsors.md diff --git a/_klipper3d/mkdocs-requirements.txt b/_klipper3d/mkdocs-requirements.txt deleted file mode 100644 index 806ec0106..000000000 --- a/_klipper3d/mkdocs-requirements.txt +++ /dev/null @@ -1,10 +0,0 @@ -# Python virtualenv module requirements for mkdocs -jinja2==3.1.6 -mkdocs==1.2.4 -mkdocs-material==8.1.3 -mkdocs-simple-hooks==0.1.3 -mkdocs-exclude==1.0.2 -mdx-truly-sane-lists==1.2 -mdx-breakless-lists==1.0.1 -py-gfm==1.0.2 -markdown==3.3.7 diff --git a/_klipper3d/mkdocs.yml b/_klipper3d/mkdocs.yml deleted file mode 100644 index e13fbe8de..000000000 --- a/_klipper3d/mkdocs.yml +++ /dev/null @@ -1,145 +0,0 @@ -# Main configuration file for mkdocs generation of klipper3d.org website - -# Note that the build-translations.sh script expects a certain file -# layout. See that script and the README file for more details. - -# Site and directory configuration -site_name: Klipper documentation -repo_url: https://github.com/Klipper3d/klipper -repo_name: Klipper3d/klipper -edit_uri: blob/master/docs/ -use_directory_urls: False -docs_dir: '../' -site_dir: '../../site/' - -# Custom markdown dialect settings -markdown_extensions: - - toc: - permalink: True - toc_depth: 6 - - attr_list - - mdx_partial_gfm - - mdx_truly_sane_lists - - mdx_breakless_lists -plugins: - search: - lang: en - mkdocs-simple-hooks: - hooks: - on_page_markdown: "docs._klipper3d.mkdocs_hooks:transform" - exclude: - glob: "README.md" - -# Website layout configuration (using mkdocs-material theme) -theme: - name: material - palette: - - media: "(prefers-color-scheme: light)" - scheme: default - primary: white - accent: blue - toggle: - icon: material/lightbulb - name: Switch to dark mode - - media: "(prefers-color-scheme: dark)" - scheme: slate - primary: grey - accent: light blue - toggle: - icon: material/lightbulb-outline - name: Switch to light mode - logo: img/klipper.svg - favicon: img/favicon.ico - icon: - repo: fontawesome/brands/github - alternate: material/web - features: - #- navigation.tabs - #- navigation.expand - - navigation.top - # if enabled, the TOC doesn't work for some pages - # - toc.integrate - - search.suggest - - search.highlight - - search.share - language: en -extra_css: - - _klipper3d/css/extra.css - -# Site usage statistics -extra: - # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#site-search-tracking - analytics: - provider: google - property: G-VEN1PGNQL4 - # Language Selection - alternate: - - name: English - link: / - lang: en - # Alternate language links automatically added here - -# Navigation hierarchy (this should mimic the layout of Overview.md) -nav: - - Overview.md - - Features.md - - FAQ.md - - Releases.md - - Config_Changes.md - - Contact.md - - Installation and Configuration: - - Installation: - - Installation.md - - OctoPrint.md - - Configuration Reference: - - Config_Reference.md - - Rotation_Distance.md - - Config_checks.md - - Bed Level: - - Bed_Level.md - - Delta_Calibrate.md - - Probe_Calibrate.md - - BLTouch.md - - Manual_Level.md - - Bed_Mesh.md - - Endstop_Phase.md - - Axis_Twist_Compensation.md - - Resonance Compensation: - - Resonance_Compensation.md - - Measuring_Resonances.md - - Pressure_Advance.md - - G-Codes.md - - Command templates: - - Command_Templates.md - - Status_Reference.md - - TMC_Drivers.md - - Multi_MCU_Homing.md - - Slicers.md - - Skew_Correction.md - - Exclude_Object.md - - Using_PWM_Tools.md - - Developer Documentation: - - Code_Overview.md - - Kinematics.md - - Protocol.md - - API_Server.md - - MCU_Commands.md - - CANBUS_protocol.md - - Debugging.md - - Benchmarks.md - - CONTRIBUTING.md - - Packaging.md - - Device Specific Documents: - - Example_Configs.md - - SDCard_Updates.md - - RPi_microcontroller.md - - Beaglebone.md - - Bootloaders.md - - Bootloader_Entry.md - - CANBUS.md - - CANBUS_Troubleshooting.md - - TSL1401CL_Filament_Width_Sensor.md - - Hall_Filament_Width_Sensor.md - - Eddy_Probe.md - - Load_Cell.md - - Sponsors.md diff --git a/_klipper3d/mkdocs_hooks.py b/_klipper3d/mkdocs_hooks.py deleted file mode 100644 index 396832c44..000000000 --- a/_klipper3d/mkdocs_hooks.py +++ /dev/null @@ -1,42 +0,0 @@ -# Tool to customize conversion of markdown files during mkdocs site generation -import re -import logging - -# This script translates some github specific markdown formatting to -# improve rendering with mkdocs. The goal is for pages to render -# similarly on both github and the web site. It has three main tasks: -# 1. Convert links outside of the docs directory (any reference -# starting with "../") to an absolute link to the raw file on -# github. -# 2. Convert a trailing backslash on a text line to a "
". -# 3. Remove leading spaces from top-level lists so that those lists -# are rendered correctly. - -logger = logging.getLogger('mkdocs.mkdocs_hooks.transform') - -def transform(markdown: str, page, config, files): - in_code_block = 0 - in_list = False - lines = markdown.splitlines() - for i in range(len(lines)): - line_out = lines[i] - in_code_block = (in_code_block + - len(re.findall("\s*[`]{3,}", line_out))) % 2 - if not in_code_block: - line_out = line_out.replace('](../', - f"]({config['repo_url']}blob/master/") - line_out = re.sub("\\\s*$", "
", line_out) - # check that lists at level 0 are not indented - # (no space before *|-|1.) - if re.match(r"^[^-*0-9 ]", line_out): - in_list = False - elif re.match(r"^(\*|-|\d+\.) ", line_out): - in_list = True - if not in_list: - line_out = re.sub(r"^\s+(\*|-|\d+\.) ", r"\1 ", line_out) - if line_out != lines[i]: - logger.debug((f'[mkdocs_hooks] rewrite line {i+1}: ' - f'"{lines[i]}" -> "{line_out}"')) - lines[i] = line_out - output = "\n".join(lines) - return output diff --git a/fr/_klipper3d/README b/fr/_klipper3d/README deleted file mode 100644 index df91f2d9f..000000000 --- a/fr/_klipper3d/README +++ /dev/null @@ -1,20 +0,0 @@ -This directory defines the https://www.klipper3d.org/ website. The -site is hosted using "github pages". The -.github/workflows/klipper3d-deploy.yaml tool uses mkdocs ( -https://www.mkdocs.org/ ) to automatically convert the markdown files -in the docs/ directory to html. In addition to the files in this -directory, the docs/CNAME file also controls the website generation. - -To test deploy the main English site locally one can use commands -similar to the following: - -virtualenv ~/mkdocs-env && ~/mkdocs-env/bin/pip install -r ~/klipper/docs/_klipper3d/mkdocs-requirements.txt -cd ~/klipper && ~/mkdocs-env/bin/mkdocs serve --config-file ~/klipper/docs/_klipper3d/mkdocs.yml -a 0.0.0.0:8000 - -To test deploy the multi-language site locally one can use commands -similar to the following: - -virtualenv ~/mkdocs-env && ~/mkdocs-env/bin/pip install -r ~/klipper/docs/_klipper3d/mkdocs-requirements.txt -source ~/mkdocs-env/bin/activate -cd ~/klipper && ./docs/_klipper3d/build-translations.sh -cd ~/klipper/site/ && python3 -m http.server 8000 diff --git a/fr/_klipper3d/__pycache__/mkdocs_hooks.cpython-38.pyc b/fr/_klipper3d/__pycache__/mkdocs_hooks.cpython-38.pyc deleted file mode 100644 index 221e8754c..000000000 Binary files a/fr/_klipper3d/__pycache__/mkdocs_hooks.cpython-38.pyc and /dev/null differ diff --git a/fr/_klipper3d/build-translations.sh b/fr/_klipper3d/build-translations.sh deleted file mode 100644 index 4a0117c24..000000000 --- a/fr/_klipper3d/build-translations.sh +++ /dev/null @@ -1,84 +0,0 @@ -#!/bin/bash -# This script extracts the Klipper translations and builds multiple -# mdocs sites - one for each supported language. See the README file -# for additional details. - -MKDOCS_DIR="docs/_klipper3d/" -WORK_DIR="work/" -TRANS_DIR="${WORK_DIR}klipper-translations/" -TRANS_FILE="${TRANS_DIR}active_translations" -MKDOCS_MAIN="${MKDOCS_DIR}mkdocs-main.yml" - -# Fetch translations -git clone --depth 1 https://github.com/Klipper3d/klipper-translations ${TRANS_DIR} - -# Create new mkdocs-main.yml with language links -cp ${MKDOCS_DIR}mkdocs.yml ${MKDOCS_MAIN} -while IFS="," read dirname langsite langdesc langsearch; do - sed -i "s%^.*# Alternate language links automatically added here$% - name: ${langdesc}\n link: /${langsite}/\n lang: ${langsite}\n\0%" ${MKDOCS_MAIN} -done < <(egrep -v '^ *(#|$)' ${TRANS_FILE}) - -# Build main English website -echo "building site for en" -mkdocs build -f ${MKDOCS_MAIN} - -# Build each additional language website -while IFS="," read dirname langsite langdesc langsearch; do - new_docs_dir="${WORK_DIR}lang/${langsite}/docs/" - locale_dir="${TRANS_DIR}/docs/locales/${dirname}" - - # read toc - title=$(sed -n '1p' ${locale_dir}/Navigation.md) - installation_and_configuration=$(sed -n '3p' ${locale_dir}/Navigation.md) - configuration_reference=$(sed -n '5p' ${locale_dir}/Navigation.md) - bed_level=$(sed -n '7p' ${locale_dir}/Navigation.md) - resonance_compensation=$(sed -n '9p' ${locale_dir}/Navigation.md) - command_template=$(sed -n '11p' ${locale_dir}/Navigation.md) - developer_documentation=$(sed -n '13p' ${locale_dir}/Navigation.md) - device_specific_documents=$(sed -n '15p' ${locale_dir}/Navigation.md) - - # Copy markdown files to new_docs_dir - echo "Copying $dirname to $langsite" - mkdir -p "${new_docs_dir}" - cp "${locale_dir}"/*.md "${new_docs_dir}" - echo "copy resources" - cp -r docs/img "${new_docs_dir}" - cp -r docs/prints "${new_docs_dir}" - cp -r docs/_klipper3d "${new_docs_dir}" - - # manually replace index.md if a manual-index.md exist - manual_index="${new_docs_dir}manual-index.md" - if [[ -f "${manual_index}" ]]; then - mv -f "${manual_index}" "${new_docs_dir}index.md" - echo "replaced index.md with manual_index.md for $langsite" - else - echo "Manually translated index file for $langsite not found!" - fi - - # Create language specific mkdocs-lang-xxx.yml file - echo "create language specific mkdocs configurations for ${langsite}" - new_mkdocs_file="${new_docs_dir}_klipper3d/mkdocs-lang-${langsite}.yml" - cp "${MKDOCS_MAIN}" "${new_mkdocs_file}" - - echo "replace search language" - sed -i "s%^ lang: en$% lang: ${langsearch}%" "${new_mkdocs_file}" - - echo "replace site language" - sed -i "s%^ language: en$% language: ${langsite}%" "${new_mkdocs_file}" - - echo "replace toc" - sed -i "s%Klipper documentation$%${title}%" "${new_mkdocs_file}" - sed -i "s%Installation and Configuration:$%${installation_and_configuration}:%" "${new_mkdocs_file}" - sed -i "s%Configuration Reference:$%${configuration_reference}:%" "${new_mkdocs_file}" - sed -i "s%Bed Level:$%${bed_level}:%" "${new_mkdocs_file}" - sed -i "s%Resonance Compensation:$%${resonance_compensation}:%" "${new_mkdocs_file}" - sed -i "s%Command templates:$%${command_template}:%" "${new_mkdocs_file}" - sed -i "s%Developer Documentation:$%${developer_documentation}:%" "${new_mkdocs_file}" - sed -i "s%Device Specific Documents:$%${device_specific_documents}:%" "${new_mkdocs_file}" - - # Build site - echo "building site for ${langsite}" - mkdir -p "${PWD}/site/${langsite}/" - ln -sf "${PWD}/site/${langsite}/" "${WORK_DIR}lang/${langsite}/site" - mkdocs build -f "${new_mkdocs_file}" -done < <(egrep -v '^ *(#|$)' ${TRANS_FILE}) diff --git a/fr/_klipper3d/css/extra.css b/fr/_klipper3d/css/extra.css deleted file mode 100644 index ea57721b0..000000000 --- a/fr/_klipper3d/css/extra.css +++ /dev/null @@ -1,16 +0,0 @@ -/* Customization of mkdocs generated site */ -[data-md-color-scheme="slate"] { - --md-primary-fg-color: hsla(var(--md-hue),15%,12%,1); - --md-default-bg-color: hsla(var(--md-hue),17%,17%,1); - --md-typeset-a-color: steelblue; - --md-accent-fg-color: lightblue; -} - -img { - background-color: white; -} - -.center-image { - margin: 0 auto; - display: block; -} diff --git a/fr/_klipper3d/mkdocs-lang-fr.yml b/fr/_klipper3d/mkdocs-lang-fr.yml deleted file mode 100644 index 721040074..000000000 --- a/fr/_klipper3d/mkdocs-lang-fr.yml +++ /dev/null @@ -1,160 +0,0 @@ -# Main configuration file for mkdocs generation of klipper3d.org website - -# Note that the build-translations.sh script expects a certain file -# layout. See that script and the README file for more details. - -# Site and directory configuration -site_name: Documentation Klipper -repo_url: https://github.com/Klipper3d/klipper -repo_name: Klipper3d/klipper -edit_uri: blob/master/docs/ -use_directory_urls: False -docs_dir: '../' -site_dir: '../../site/' - -# Custom markdown dialect settings -markdown_extensions: - - toc: - permalink: True - toc_depth: 6 - - attr_list - - mdx_partial_gfm - - mdx_truly_sane_lists - - mdx_breakless_lists -plugins: - search: - lang: fr - mkdocs-simple-hooks: - hooks: - on_page_markdown: "docs._klipper3d.mkdocs_hooks:transform" - exclude: - glob: "README.md" - -# Website layout configuration (using mkdocs-material theme) -theme: - name: material - palette: - - media: "(prefers-color-scheme: light)" - scheme: default - primary: white - accent: blue - toggle: - icon: material/lightbulb - name: Switch to dark mode - - media: "(prefers-color-scheme: dark)" - scheme: slate - primary: grey - accent: light blue - toggle: - icon: material/lightbulb-outline - name: Switch to light mode - logo: img/klipper.svg - favicon: img/favicon.ico - icon: - repo: fontawesome/brands/github - alternate: material/web - features: - #- navigation.tabs - #- navigation.expand - - navigation.top - # if enabled, the TOC doesn't work for some pages - # - toc.integrate - - search.suggest - - search.highlight - - search.share - language: fr -extra_css: - - _klipper3d/css/extra.css - -# Site usage statistics -extra: - # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#site-search-tracking - analytics: - provider: google - property: G-VEN1PGNQL4 - # Language Selection - alternate: - - name: English - link: / - lang: en - - name: 简体中文 - link: /zh/ - lang: zh - - name: 繁體中文 - link: /zh-Hant/ - lang: zh-Hant - - name: Magyar - link: /hu/ - lang: hu - - name: Italiano - link: /it/ - lang: it - - name: Français - link: /fr/ - lang: fr - # Alternate language links automatically added here - -# Navigation hierarchy (this should mimic the layout of Overview.md) -nav: - - Overview.md - - Features.md - - FAQ.md - - Releases.md - - Config_Changes.md - - Contact.md - - Installation et configuration: - - Installation: - - Installation.md - - OctoPrint.md - - Référence de configuration: - - Config_Reference.md - - Rotation_Distance.md - - Config_checks.md - - Nivellement du lit: - - Bed_Level.md - - Delta_Calibrate.md - - Probe_Calibrate.md - - BLTouch.md - - Manual_Level.md - - Bed_Mesh.md - - Endstop_Phase.md - - Axis_Twist_Compensation.md - - Compensation de la résonance: - - Resonance_Compensation.md - - Measuring_Resonances.md - - Pressure_Advance.md - - G-Codes.md - - Modèles de commandes: - - Command_Templates.md - - Status_Reference.md - - TMC_Drivers.md - - Multi_MCU_Homing.md - - Slicers.md - - Skew_Correction.md - - Exclude_Object.md - - Using_PWM_Tools.md - - Documentation pour les développeurs: - - Code_Overview.md - - Kinematics.md - - Protocol.md - - API_Server.md - - MCU_Commands.md - - CANBUS_protocol.md - - Debugging.md - - Benchmarks.md - - CONTRIBUTING.md - - Packaging.md - - Documents spécifiques à certains appareils: - - Example_Configs.md - - SDCard_Updates.md - - RPi_microcontroller.md - - Beaglebone.md - - Bootloaders.md - - Bootloader_Entry.md - - CANBUS.md - - CANBUS_Troubleshooting.md - - TSL1401CL_Filament_Width_Sensor.md - - Hall_Filament_Width_Sensor.md - - Eddy_Probe.md - - Load_Cell.md - - Sponsors.md diff --git a/fr/_klipper3d/mkdocs-main.yml b/fr/_klipper3d/mkdocs-main.yml deleted file mode 100644 index 896865dd1..000000000 --- a/fr/_klipper3d/mkdocs-main.yml +++ /dev/null @@ -1,160 +0,0 @@ -# Main configuration file for mkdocs generation of klipper3d.org website - -# Note that the build-translations.sh script expects a certain file -# layout. See that script and the README file for more details. - -# Site and directory configuration -site_name: Klipper documentation -repo_url: https://github.com/Klipper3d/klipper -repo_name: Klipper3d/klipper -edit_uri: blob/master/docs/ -use_directory_urls: False -docs_dir: '../' -site_dir: '../../site/' - -# Custom markdown dialect settings -markdown_extensions: - - toc: - permalink: True - toc_depth: 6 - - attr_list - - mdx_partial_gfm - - mdx_truly_sane_lists - - mdx_breakless_lists -plugins: - search: - lang: en - mkdocs-simple-hooks: - hooks: - on_page_markdown: "docs._klipper3d.mkdocs_hooks:transform" - exclude: - glob: "README.md" - -# Website layout configuration (using mkdocs-material theme) -theme: - name: material - palette: - - media: "(prefers-color-scheme: light)" - scheme: default - primary: white - accent: blue - toggle: - icon: material/lightbulb - name: Switch to dark mode - - media: "(prefers-color-scheme: dark)" - scheme: slate - primary: grey - accent: light blue - toggle: - icon: material/lightbulb-outline - name: Switch to light mode - logo: img/klipper.svg - favicon: img/favicon.ico - icon: - repo: fontawesome/brands/github - alternate: material/web - features: - #- navigation.tabs - #- navigation.expand - - navigation.top - # if enabled, the TOC doesn't work for some pages - # - toc.integrate - - search.suggest - - search.highlight - - search.share - language: en -extra_css: - - _klipper3d/css/extra.css - -# Site usage statistics -extra: - # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#site-search-tracking - analytics: - provider: google - property: G-VEN1PGNQL4 - # Language Selection - alternate: - - name: English - link: / - lang: en - - name: 简体中文 - link: /zh/ - lang: zh - - name: 繁體中文 - link: /zh-Hant/ - lang: zh-Hant - - name: Magyar - link: /hu/ - lang: hu - - name: Italiano - link: /it/ - lang: it - - name: Français - link: /fr/ - lang: fr - # Alternate language links automatically added here - -# Navigation hierarchy (this should mimic the layout of Overview.md) -nav: - - Overview.md - - Features.md - - FAQ.md - - Releases.md - - Config_Changes.md - - Contact.md - - Installation and Configuration: - - Installation: - - Installation.md - - OctoPrint.md - - Configuration Reference: - - Config_Reference.md - - Rotation_Distance.md - - Config_checks.md - - Bed Level: - - Bed_Level.md - - Delta_Calibrate.md - - Probe_Calibrate.md - - BLTouch.md - - Manual_Level.md - - Bed_Mesh.md - - Endstop_Phase.md - - Axis_Twist_Compensation.md - - Resonance Compensation: - - Resonance_Compensation.md - - Measuring_Resonances.md - - Pressure_Advance.md - - G-Codes.md - - Command templates: - - Command_Templates.md - - Status_Reference.md - - TMC_Drivers.md - - Multi_MCU_Homing.md - - Slicers.md - - Skew_Correction.md - - Exclude_Object.md - - Using_PWM_Tools.md - - Developer Documentation: - - Code_Overview.md - - Kinematics.md - - Protocol.md - - API_Server.md - - MCU_Commands.md - - CANBUS_protocol.md - - Debugging.md - - Benchmarks.md - - CONTRIBUTING.md - - Packaging.md - - Device Specific Documents: - - Example_Configs.md - - SDCard_Updates.md - - RPi_microcontroller.md - - Beaglebone.md - - Bootloaders.md - - Bootloader_Entry.md - - CANBUS.md - - CANBUS_Troubleshooting.md - - TSL1401CL_Filament_Width_Sensor.md - - Hall_Filament_Width_Sensor.md - - Eddy_Probe.md - - Load_Cell.md - - Sponsors.md diff --git a/fr/_klipper3d/mkdocs-requirements.txt b/fr/_klipper3d/mkdocs-requirements.txt deleted file mode 100644 index 806ec0106..000000000 --- a/fr/_klipper3d/mkdocs-requirements.txt +++ /dev/null @@ -1,10 +0,0 @@ -# Python virtualenv module requirements for mkdocs -jinja2==3.1.6 -mkdocs==1.2.4 -mkdocs-material==8.1.3 -mkdocs-simple-hooks==0.1.3 -mkdocs-exclude==1.0.2 -mdx-truly-sane-lists==1.2 -mdx-breakless-lists==1.0.1 -py-gfm==1.0.2 -markdown==3.3.7 diff --git a/fr/_klipper3d/mkdocs.yml b/fr/_klipper3d/mkdocs.yml deleted file mode 100644 index e13fbe8de..000000000 --- a/fr/_klipper3d/mkdocs.yml +++ /dev/null @@ -1,145 +0,0 @@ -# Main configuration file for mkdocs generation of klipper3d.org website - -# Note that the build-translations.sh script expects a certain file -# layout. See that script and the README file for more details. - -# Site and directory configuration -site_name: Klipper documentation -repo_url: https://github.com/Klipper3d/klipper -repo_name: Klipper3d/klipper -edit_uri: blob/master/docs/ -use_directory_urls: False -docs_dir: '../' -site_dir: '../../site/' - -# Custom markdown dialect settings -markdown_extensions: - - toc: - permalink: True - toc_depth: 6 - - attr_list - - mdx_partial_gfm - - mdx_truly_sane_lists - - mdx_breakless_lists -plugins: - search: - lang: en - mkdocs-simple-hooks: - hooks: - on_page_markdown: "docs._klipper3d.mkdocs_hooks:transform" - exclude: - glob: "README.md" - -# Website layout configuration (using mkdocs-material theme) -theme: - name: material - palette: - - media: "(prefers-color-scheme: light)" - scheme: default - primary: white - accent: blue - toggle: - icon: material/lightbulb - name: Switch to dark mode - - media: "(prefers-color-scheme: dark)" - scheme: slate - primary: grey - accent: light blue - toggle: - icon: material/lightbulb-outline - name: Switch to light mode - logo: img/klipper.svg - favicon: img/favicon.ico - icon: - repo: fontawesome/brands/github - alternate: material/web - features: - #- navigation.tabs - #- navigation.expand - - navigation.top - # if enabled, the TOC doesn't work for some pages - # - toc.integrate - - search.suggest - - search.highlight - - search.share - language: en -extra_css: - - _klipper3d/css/extra.css - -# Site usage statistics -extra: - # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#site-search-tracking - analytics: - provider: google - property: G-VEN1PGNQL4 - # Language Selection - alternate: - - name: English - link: / - lang: en - # Alternate language links automatically added here - -# Navigation hierarchy (this should mimic the layout of Overview.md) -nav: - - Overview.md - - Features.md - - FAQ.md - - Releases.md - - Config_Changes.md - - Contact.md - - Installation and Configuration: - - Installation: - - Installation.md - - OctoPrint.md - - Configuration Reference: - - Config_Reference.md - - Rotation_Distance.md - - Config_checks.md - - Bed Level: - - Bed_Level.md - - Delta_Calibrate.md - - Probe_Calibrate.md - - BLTouch.md - - Manual_Level.md - - Bed_Mesh.md - - Endstop_Phase.md - - Axis_Twist_Compensation.md - - Resonance Compensation: - - Resonance_Compensation.md - - Measuring_Resonances.md - - Pressure_Advance.md - - G-Codes.md - - Command templates: - - Command_Templates.md - - Status_Reference.md - - TMC_Drivers.md - - Multi_MCU_Homing.md - - Slicers.md - - Skew_Correction.md - - Exclude_Object.md - - Using_PWM_Tools.md - - Developer Documentation: - - Code_Overview.md - - Kinematics.md - - Protocol.md - - API_Server.md - - MCU_Commands.md - - CANBUS_protocol.md - - Debugging.md - - Benchmarks.md - - CONTRIBUTING.md - - Packaging.md - - Device Specific Documents: - - Example_Configs.md - - SDCard_Updates.md - - RPi_microcontroller.md - - Beaglebone.md - - Bootloaders.md - - Bootloader_Entry.md - - CANBUS.md - - CANBUS_Troubleshooting.md - - TSL1401CL_Filament_Width_Sensor.md - - Hall_Filament_Width_Sensor.md - - Eddy_Probe.md - - Load_Cell.md - - Sponsors.md diff --git a/fr/_klipper3d/mkdocs_hooks.py b/fr/_klipper3d/mkdocs_hooks.py deleted file mode 100644 index 396832c44..000000000 --- a/fr/_klipper3d/mkdocs_hooks.py +++ /dev/null @@ -1,42 +0,0 @@ -# Tool to customize conversion of markdown files during mkdocs site generation -import re -import logging - -# This script translates some github specific markdown formatting to -# improve rendering with mkdocs. The goal is for pages to render -# similarly on both github and the web site. It has three main tasks: -# 1. Convert links outside of the docs directory (any reference -# starting with "../") to an absolute link to the raw file on -# github. -# 2. Convert a trailing backslash on a text line to a "
". -# 3. Remove leading spaces from top-level lists so that those lists -# are rendered correctly. - -logger = logging.getLogger('mkdocs.mkdocs_hooks.transform') - -def transform(markdown: str, page, config, files): - in_code_block = 0 - in_list = False - lines = markdown.splitlines() - for i in range(len(lines)): - line_out = lines[i] - in_code_block = (in_code_block + - len(re.findall("\s*[`]{3,}", line_out))) % 2 - if not in_code_block: - line_out = line_out.replace('](../', - f"]({config['repo_url']}blob/master/") - line_out = re.sub("\\\s*$", "
", line_out) - # check that lists at level 0 are not indented - # (no space before *|-|1.) - if re.match(r"^[^-*0-9 ]", line_out): - in_list = False - elif re.match(r"^(\*|-|\d+\.) ", line_out): - in_list = True - if not in_list: - line_out = re.sub(r"^\s+(\*|-|\d+\.) ", r"\1 ", line_out) - if line_out != lines[i]: - logger.debug((f'[mkdocs_hooks] rewrite line {i+1}: ' - f'"{lines[i]}" -> "{line_out}"')) - lines[i] = line_out - output = "\n".join(lines) - return output diff --git a/fr/sitemap.xml b/fr/sitemap.xml deleted file mode 100644 index 0809d3a19..000000000 --- a/fr/sitemap.xml +++ /dev/null @@ -1,283 +0,0 @@ - - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - \ No newline at end of file diff --git a/fr/sitemap.xml.gz b/fr/sitemap.xml.gz deleted file mode 100644 index c793de0ad..000000000 Binary files a/fr/sitemap.xml.gz and /dev/null differ diff --git a/hu/_klipper3d/README b/hu/_klipper3d/README deleted file mode 100644 index df91f2d9f..000000000 --- a/hu/_klipper3d/README +++ /dev/null @@ -1,20 +0,0 @@ -This directory defines the https://www.klipper3d.org/ website. The -site is hosted using "github pages". The -.github/workflows/klipper3d-deploy.yaml tool uses mkdocs ( -https://www.mkdocs.org/ ) to automatically convert the markdown files -in the docs/ directory to html. In addition to the files in this -directory, the docs/CNAME file also controls the website generation. - -To test deploy the main English site locally one can use commands -similar to the following: - -virtualenv ~/mkdocs-env && ~/mkdocs-env/bin/pip install -r ~/klipper/docs/_klipper3d/mkdocs-requirements.txt -cd ~/klipper && ~/mkdocs-env/bin/mkdocs serve --config-file ~/klipper/docs/_klipper3d/mkdocs.yml -a 0.0.0.0:8000 - -To test deploy the multi-language site locally one can use commands -similar to the following: - -virtualenv ~/mkdocs-env && ~/mkdocs-env/bin/pip install -r ~/klipper/docs/_klipper3d/mkdocs-requirements.txt -source ~/mkdocs-env/bin/activate -cd ~/klipper && ./docs/_klipper3d/build-translations.sh -cd ~/klipper/site/ && python3 -m http.server 8000 diff --git a/hu/_klipper3d/__pycache__/mkdocs_hooks.cpython-38.pyc b/hu/_klipper3d/__pycache__/mkdocs_hooks.cpython-38.pyc deleted file mode 100644 index 221e8754c..000000000 Binary files a/hu/_klipper3d/__pycache__/mkdocs_hooks.cpython-38.pyc and /dev/null differ diff --git a/hu/_klipper3d/build-translations.sh b/hu/_klipper3d/build-translations.sh deleted file mode 100644 index 4a0117c24..000000000 --- a/hu/_klipper3d/build-translations.sh +++ /dev/null @@ -1,84 +0,0 @@ -#!/bin/bash -# This script extracts the Klipper translations and builds multiple -# mdocs sites - one for each supported language. See the README file -# for additional details. - -MKDOCS_DIR="docs/_klipper3d/" -WORK_DIR="work/" -TRANS_DIR="${WORK_DIR}klipper-translations/" -TRANS_FILE="${TRANS_DIR}active_translations" -MKDOCS_MAIN="${MKDOCS_DIR}mkdocs-main.yml" - -# Fetch translations -git clone --depth 1 https://github.com/Klipper3d/klipper-translations ${TRANS_DIR} - -# Create new mkdocs-main.yml with language links -cp ${MKDOCS_DIR}mkdocs.yml ${MKDOCS_MAIN} -while IFS="," read dirname langsite langdesc langsearch; do - sed -i "s%^.*# Alternate language links automatically added here$% - name: ${langdesc}\n link: /${langsite}/\n lang: ${langsite}\n\0%" ${MKDOCS_MAIN} -done < <(egrep -v '^ *(#|$)' ${TRANS_FILE}) - -# Build main English website -echo "building site for en" -mkdocs build -f ${MKDOCS_MAIN} - -# Build each additional language website -while IFS="," read dirname langsite langdesc langsearch; do - new_docs_dir="${WORK_DIR}lang/${langsite}/docs/" - locale_dir="${TRANS_DIR}/docs/locales/${dirname}" - - # read toc - title=$(sed -n '1p' ${locale_dir}/Navigation.md) - installation_and_configuration=$(sed -n '3p' ${locale_dir}/Navigation.md) - configuration_reference=$(sed -n '5p' ${locale_dir}/Navigation.md) - bed_level=$(sed -n '7p' ${locale_dir}/Navigation.md) - resonance_compensation=$(sed -n '9p' ${locale_dir}/Navigation.md) - command_template=$(sed -n '11p' ${locale_dir}/Navigation.md) - developer_documentation=$(sed -n '13p' ${locale_dir}/Navigation.md) - device_specific_documents=$(sed -n '15p' ${locale_dir}/Navigation.md) - - # Copy markdown files to new_docs_dir - echo "Copying $dirname to $langsite" - mkdir -p "${new_docs_dir}" - cp "${locale_dir}"/*.md "${new_docs_dir}" - echo "copy resources" - cp -r docs/img "${new_docs_dir}" - cp -r docs/prints "${new_docs_dir}" - cp -r docs/_klipper3d "${new_docs_dir}" - - # manually replace index.md if a manual-index.md exist - manual_index="${new_docs_dir}manual-index.md" - if [[ -f "${manual_index}" ]]; then - mv -f "${manual_index}" "${new_docs_dir}index.md" - echo "replaced index.md with manual_index.md for $langsite" - else - echo "Manually translated index file for $langsite not found!" - fi - - # Create language specific mkdocs-lang-xxx.yml file - echo "create language specific mkdocs configurations for ${langsite}" - new_mkdocs_file="${new_docs_dir}_klipper3d/mkdocs-lang-${langsite}.yml" - cp "${MKDOCS_MAIN}" "${new_mkdocs_file}" - - echo "replace search language" - sed -i "s%^ lang: en$% lang: ${langsearch}%" "${new_mkdocs_file}" - - echo "replace site language" - sed -i "s%^ language: en$% language: ${langsite}%" "${new_mkdocs_file}" - - echo "replace toc" - sed -i "s%Klipper documentation$%${title}%" "${new_mkdocs_file}" - sed -i "s%Installation and Configuration:$%${installation_and_configuration}:%" "${new_mkdocs_file}" - sed -i "s%Configuration Reference:$%${configuration_reference}:%" "${new_mkdocs_file}" - sed -i "s%Bed Level:$%${bed_level}:%" "${new_mkdocs_file}" - sed -i "s%Resonance Compensation:$%${resonance_compensation}:%" "${new_mkdocs_file}" - sed -i "s%Command templates:$%${command_template}:%" "${new_mkdocs_file}" - sed -i "s%Developer Documentation:$%${developer_documentation}:%" "${new_mkdocs_file}" - sed -i "s%Device Specific Documents:$%${device_specific_documents}:%" "${new_mkdocs_file}" - - # Build site - echo "building site for ${langsite}" - mkdir -p "${PWD}/site/${langsite}/" - ln -sf "${PWD}/site/${langsite}/" "${WORK_DIR}lang/${langsite}/site" - mkdocs build -f "${new_mkdocs_file}" -done < <(egrep -v '^ *(#|$)' ${TRANS_FILE}) diff --git a/hu/_klipper3d/css/extra.css b/hu/_klipper3d/css/extra.css deleted file mode 100644 index ea57721b0..000000000 --- a/hu/_klipper3d/css/extra.css +++ /dev/null @@ -1,16 +0,0 @@ -/* Customization of mkdocs generated site */ -[data-md-color-scheme="slate"] { - --md-primary-fg-color: hsla(var(--md-hue),15%,12%,1); - --md-default-bg-color: hsla(var(--md-hue),17%,17%,1); - --md-typeset-a-color: steelblue; - --md-accent-fg-color: lightblue; -} - -img { - background-color: white; -} - -.center-image { - margin: 0 auto; - display: block; -} diff --git a/hu/_klipper3d/mkdocs-lang-hu.yml b/hu/_klipper3d/mkdocs-lang-hu.yml deleted file mode 100644 index 39c747e64..000000000 --- a/hu/_klipper3d/mkdocs-lang-hu.yml +++ /dev/null @@ -1,160 +0,0 @@ -# Main configuration file for mkdocs generation of klipper3d.org website - -# Note that the build-translations.sh script expects a certain file -# layout. See that script and the README file for more details. - -# Site and directory configuration -site_name: Klipper dokumentáció -repo_url: https://github.com/Klipper3d/klipper -repo_name: Klipper3d/klipper -edit_uri: blob/master/docs/ -use_directory_urls: False -docs_dir: '../' -site_dir: '../../site/' - -# Custom markdown dialect settings -markdown_extensions: - - toc: - permalink: True - toc_depth: 6 - - attr_list - - mdx_partial_gfm - - mdx_truly_sane_lists - - mdx_breakless_lists -plugins: - search: - lang: hu - mkdocs-simple-hooks: - hooks: - on_page_markdown: "docs._klipper3d.mkdocs_hooks:transform" - exclude: - glob: "README.md" - -# Website layout configuration (using mkdocs-material theme) -theme: - name: material - palette: - - media: "(prefers-color-scheme: light)" - scheme: default - primary: white - accent: blue - toggle: - icon: material/lightbulb - name: Switch to dark mode - - media: "(prefers-color-scheme: dark)" - scheme: slate - primary: grey - accent: light blue - toggle: - icon: material/lightbulb-outline - name: Switch to light mode - logo: img/klipper.svg - favicon: img/favicon.ico - icon: - repo: fontawesome/brands/github - alternate: material/web - features: - #- navigation.tabs - #- navigation.expand - - navigation.top - # if enabled, the TOC doesn't work for some pages - # - toc.integrate - - search.suggest - - search.highlight - - search.share - language: hu -extra_css: - - _klipper3d/css/extra.css - -# Site usage statistics -extra: - # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#site-search-tracking - analytics: - provider: google - property: G-VEN1PGNQL4 - # Language Selection - alternate: - - name: English - link: / - lang: en - - name: 简体中文 - link: /zh/ - lang: zh - - name: 繁體中文 - link: /zh-Hant/ - lang: zh-Hant - - name: Magyar - link: /hu/ - lang: hu - - name: Italiano - link: /it/ - lang: it - - name: Français - link: /fr/ - lang: fr - # Alternate language links automatically added here - -# Navigation hierarchy (this should mimic the layout of Overview.md) -nav: - - Overview.md - - Features.md - - FAQ.md - - Releases.md - - Config_Changes.md - - Contact.md - - Telepítés és Konfiguráció: - - Installation: - - Installation.md - - OctoPrint.md - - Konfigurációs Hivatkozás: - - Config_Reference.md - - Rotation_Distance.md - - Config_checks.md - - Tárgyasztal szint: - - Bed_Level.md - - Delta_Calibrate.md - - Probe_Calibrate.md - - BLTouch.md - - Manual_Level.md - - Bed_Mesh.md - - Endstop_Phase.md - - Axis_Twist_Compensation.md - - Rezonancia Kompenzáció: - - Resonance_Compensation.md - - Measuring_Resonances.md - - Pressure_Advance.md - - G-Codes.md - - Parancssablonok: - - Command_Templates.md - - Status_Reference.md - - TMC_Drivers.md - - Multi_MCU_Homing.md - - Slicers.md - - Skew_Correction.md - - Exclude_Object.md - - Using_PWM_Tools.md - - Fejlesztői Dokumentáció: - - Code_Overview.md - - Kinematics.md - - Protocol.md - - API_Server.md - - MCU_Commands.md - - CANBUS_protocol.md - - Debugging.md - - Benchmarks.md - - CONTRIBUTING.md - - Packaging.md - - Eszközspecifikus Dokumentumok: - - Example_Configs.md - - SDCard_Updates.md - - RPi_microcontroller.md - - Beaglebone.md - - Bootloaders.md - - Bootloader_Entry.md - - CANBUS.md - - CANBUS_Troubleshooting.md - - TSL1401CL_Filament_Width_Sensor.md - - Hall_Filament_Width_Sensor.md - - Eddy_Probe.md - - Load_Cell.md - - Sponsors.md diff --git a/hu/_klipper3d/mkdocs-main.yml b/hu/_klipper3d/mkdocs-main.yml deleted file mode 100644 index 896865dd1..000000000 --- a/hu/_klipper3d/mkdocs-main.yml +++ /dev/null @@ -1,160 +0,0 @@ -# Main configuration file for mkdocs generation of klipper3d.org website - -# Note that the build-translations.sh script expects a certain file -# layout. See that script and the README file for more details. - -# Site and directory configuration -site_name: Klipper documentation -repo_url: https://github.com/Klipper3d/klipper -repo_name: Klipper3d/klipper -edit_uri: blob/master/docs/ -use_directory_urls: False -docs_dir: '../' -site_dir: '../../site/' - -# Custom markdown dialect settings -markdown_extensions: - - toc: - permalink: True - toc_depth: 6 - - attr_list - - mdx_partial_gfm - - mdx_truly_sane_lists - - mdx_breakless_lists -plugins: - search: - lang: en - mkdocs-simple-hooks: - hooks: - on_page_markdown: "docs._klipper3d.mkdocs_hooks:transform" - exclude: - glob: "README.md" - -# Website layout configuration (using mkdocs-material theme) -theme: - name: material - palette: - - media: "(prefers-color-scheme: light)" - scheme: default - primary: white - accent: blue - toggle: - icon: material/lightbulb - name: Switch to dark mode - - media: "(prefers-color-scheme: dark)" - scheme: slate - primary: grey - accent: light blue - toggle: - icon: material/lightbulb-outline - name: Switch to light mode - logo: img/klipper.svg - favicon: img/favicon.ico - icon: - repo: fontawesome/brands/github - alternate: material/web - features: - #- navigation.tabs - #- navigation.expand - - navigation.top - # if enabled, the TOC doesn't work for some pages - # - toc.integrate - - search.suggest - - search.highlight - - search.share - language: en -extra_css: - - _klipper3d/css/extra.css - -# Site usage statistics -extra: - # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#site-search-tracking - analytics: - provider: google - property: G-VEN1PGNQL4 - # Language Selection - alternate: - - name: English - link: / - lang: en - - name: 简体中文 - link: /zh/ - lang: zh - - name: 繁體中文 - link: /zh-Hant/ - lang: zh-Hant - - name: Magyar - link: /hu/ - lang: hu - - name: Italiano - link: /it/ - lang: it - - name: Français - link: /fr/ - lang: fr - # Alternate language links automatically added here - -# Navigation hierarchy (this should mimic the layout of Overview.md) -nav: - - Overview.md - - Features.md - - FAQ.md - - Releases.md - - Config_Changes.md - - Contact.md - - Installation and Configuration: - - Installation: - - Installation.md - - OctoPrint.md - - Configuration Reference: - - Config_Reference.md - - Rotation_Distance.md - - Config_checks.md - - Bed Level: - - Bed_Level.md - - Delta_Calibrate.md - - Probe_Calibrate.md - - BLTouch.md - - Manual_Level.md - - Bed_Mesh.md - - Endstop_Phase.md - - Axis_Twist_Compensation.md - - Resonance Compensation: - - Resonance_Compensation.md - - Measuring_Resonances.md - - Pressure_Advance.md - - G-Codes.md - - Command templates: - - Command_Templates.md - - Status_Reference.md - - TMC_Drivers.md - - Multi_MCU_Homing.md - - Slicers.md - - Skew_Correction.md - - Exclude_Object.md - - Using_PWM_Tools.md - - Developer Documentation: - - Code_Overview.md - - Kinematics.md - - Protocol.md - - API_Server.md - - MCU_Commands.md - - CANBUS_protocol.md - - Debugging.md - - Benchmarks.md - - CONTRIBUTING.md - - Packaging.md - - Device Specific Documents: - - Example_Configs.md - - SDCard_Updates.md - - RPi_microcontroller.md - - Beaglebone.md - - Bootloaders.md - - Bootloader_Entry.md - - CANBUS.md - - CANBUS_Troubleshooting.md - - TSL1401CL_Filament_Width_Sensor.md - - Hall_Filament_Width_Sensor.md - - Eddy_Probe.md - - Load_Cell.md - - Sponsors.md diff --git a/hu/_klipper3d/mkdocs-requirements.txt b/hu/_klipper3d/mkdocs-requirements.txt deleted file mode 100644 index 806ec0106..000000000 --- a/hu/_klipper3d/mkdocs-requirements.txt +++ /dev/null @@ -1,10 +0,0 @@ -# Python virtualenv module requirements for mkdocs -jinja2==3.1.6 -mkdocs==1.2.4 -mkdocs-material==8.1.3 -mkdocs-simple-hooks==0.1.3 -mkdocs-exclude==1.0.2 -mdx-truly-sane-lists==1.2 -mdx-breakless-lists==1.0.1 -py-gfm==1.0.2 -markdown==3.3.7 diff --git a/hu/_klipper3d/mkdocs.yml b/hu/_klipper3d/mkdocs.yml deleted file mode 100644 index e13fbe8de..000000000 --- a/hu/_klipper3d/mkdocs.yml +++ /dev/null @@ -1,145 +0,0 @@ -# Main configuration file for mkdocs generation of klipper3d.org website - -# Note that the build-translations.sh script expects a certain file -# layout. See that script and the README file for more details. - -# Site and directory configuration -site_name: Klipper documentation -repo_url: https://github.com/Klipper3d/klipper -repo_name: Klipper3d/klipper -edit_uri: blob/master/docs/ -use_directory_urls: False -docs_dir: '../' -site_dir: '../../site/' - -# Custom markdown dialect settings -markdown_extensions: - - toc: - permalink: True - toc_depth: 6 - - attr_list - - mdx_partial_gfm - - mdx_truly_sane_lists - - mdx_breakless_lists -plugins: - search: - lang: en - mkdocs-simple-hooks: - hooks: - on_page_markdown: "docs._klipper3d.mkdocs_hooks:transform" - exclude: - glob: "README.md" - -# Website layout configuration (using mkdocs-material theme) -theme: - name: material - palette: - - media: "(prefers-color-scheme: light)" - scheme: default - primary: white - accent: blue - toggle: - icon: material/lightbulb - name: Switch to dark mode - - media: "(prefers-color-scheme: dark)" - scheme: slate - primary: grey - accent: light blue - toggle: - icon: material/lightbulb-outline - name: Switch to light mode - logo: img/klipper.svg - favicon: img/favicon.ico - icon: - repo: fontawesome/brands/github - alternate: material/web - features: - #- navigation.tabs - #- navigation.expand - - navigation.top - # if enabled, the TOC doesn't work for some pages - # - toc.integrate - - search.suggest - - search.highlight - - search.share - language: en -extra_css: - - _klipper3d/css/extra.css - -# Site usage statistics -extra: - # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#site-search-tracking - analytics: - provider: google - property: G-VEN1PGNQL4 - # Language Selection - alternate: - - name: English - link: / - lang: en - # Alternate language links automatically added here - -# Navigation hierarchy (this should mimic the layout of Overview.md) -nav: - - Overview.md - - Features.md - - FAQ.md - - Releases.md - - Config_Changes.md - - Contact.md - - Installation and Configuration: - - Installation: - - Installation.md - - OctoPrint.md - - Configuration Reference: - - Config_Reference.md - - Rotation_Distance.md - - Config_checks.md - - Bed Level: - - Bed_Level.md - - Delta_Calibrate.md - - Probe_Calibrate.md - - BLTouch.md - - Manual_Level.md - - Bed_Mesh.md - - Endstop_Phase.md - - Axis_Twist_Compensation.md - - Resonance Compensation: - - Resonance_Compensation.md - - Measuring_Resonances.md - - Pressure_Advance.md - - G-Codes.md - - Command templates: - - Command_Templates.md - - Status_Reference.md - - TMC_Drivers.md - - Multi_MCU_Homing.md - - Slicers.md - - Skew_Correction.md - - Exclude_Object.md - - Using_PWM_Tools.md - - Developer Documentation: - - Code_Overview.md - - Kinematics.md - - Protocol.md - - API_Server.md - - MCU_Commands.md - - CANBUS_protocol.md - - Debugging.md - - Benchmarks.md - - CONTRIBUTING.md - - Packaging.md - - Device Specific Documents: - - Example_Configs.md - - SDCard_Updates.md - - RPi_microcontroller.md - - Beaglebone.md - - Bootloaders.md - - Bootloader_Entry.md - - CANBUS.md - - CANBUS_Troubleshooting.md - - TSL1401CL_Filament_Width_Sensor.md - - Hall_Filament_Width_Sensor.md - - Eddy_Probe.md - - Load_Cell.md - - Sponsors.md diff --git a/hu/_klipper3d/mkdocs_hooks.py b/hu/_klipper3d/mkdocs_hooks.py deleted file mode 100644 index 396832c44..000000000 --- a/hu/_klipper3d/mkdocs_hooks.py +++ /dev/null @@ -1,42 +0,0 @@ -# Tool to customize conversion of markdown files during mkdocs site generation -import re -import logging - -# This script translates some github specific markdown formatting to -# improve rendering with mkdocs. The goal is for pages to render -# similarly on both github and the web site. It has three main tasks: -# 1. Convert links outside of the docs directory (any reference -# starting with "../") to an absolute link to the raw file on -# github. -# 2. Convert a trailing backslash on a text line to a "
". -# 3. Remove leading spaces from top-level lists so that those lists -# are rendered correctly. - -logger = logging.getLogger('mkdocs.mkdocs_hooks.transform') - -def transform(markdown: str, page, config, files): - in_code_block = 0 - in_list = False - lines = markdown.splitlines() - for i in range(len(lines)): - line_out = lines[i] - in_code_block = (in_code_block + - len(re.findall("\s*[`]{3,}", line_out))) % 2 - if not in_code_block: - line_out = line_out.replace('](../', - f"]({config['repo_url']}blob/master/") - line_out = re.sub("\\\s*$", "
", line_out) - # check that lists at level 0 are not indented - # (no space before *|-|1.) - if re.match(r"^[^-*0-9 ]", line_out): - in_list = False - elif re.match(r"^(\*|-|\d+\.) ", line_out): - in_list = True - if not in_list: - line_out = re.sub(r"^\s+(\*|-|\d+\.) ", r"\1 ", line_out) - if line_out != lines[i]: - logger.debug((f'[mkdocs_hooks] rewrite line {i+1}: ' - f'"{lines[i]}" -> "{line_out}"')) - lines[i] = line_out - output = "\n".join(lines) - return output diff --git a/hu/sitemap.xml b/hu/sitemap.xml deleted file mode 100644 index 0809d3a19..000000000 --- a/hu/sitemap.xml +++ /dev/null @@ -1,283 +0,0 @@ - - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - \ No newline at end of file diff --git a/hu/sitemap.xml.gz b/hu/sitemap.xml.gz deleted file mode 100644 index 2ea924d34..000000000 Binary files a/hu/sitemap.xml.gz and /dev/null differ diff --git a/it/_klipper3d/README b/it/_klipper3d/README deleted file mode 100644 index df91f2d9f..000000000 --- a/it/_klipper3d/README +++ /dev/null @@ -1,20 +0,0 @@ -This directory defines the https://www.klipper3d.org/ website. The -site is hosted using "github pages". The -.github/workflows/klipper3d-deploy.yaml tool uses mkdocs ( -https://www.mkdocs.org/ ) to automatically convert the markdown files -in the docs/ directory to html. In addition to the files in this -directory, the docs/CNAME file also controls the website generation. - -To test deploy the main English site locally one can use commands -similar to the following: - -virtualenv ~/mkdocs-env && ~/mkdocs-env/bin/pip install -r ~/klipper/docs/_klipper3d/mkdocs-requirements.txt -cd ~/klipper && ~/mkdocs-env/bin/mkdocs serve --config-file ~/klipper/docs/_klipper3d/mkdocs.yml -a 0.0.0.0:8000 - -To test deploy the multi-language site locally one can use commands -similar to the following: - -virtualenv ~/mkdocs-env && ~/mkdocs-env/bin/pip install -r ~/klipper/docs/_klipper3d/mkdocs-requirements.txt -source ~/mkdocs-env/bin/activate -cd ~/klipper && ./docs/_klipper3d/build-translations.sh -cd ~/klipper/site/ && python3 -m http.server 8000 diff --git a/it/_klipper3d/__pycache__/mkdocs_hooks.cpython-38.pyc b/it/_klipper3d/__pycache__/mkdocs_hooks.cpython-38.pyc deleted file mode 100644 index 221e8754c..000000000 Binary files a/it/_klipper3d/__pycache__/mkdocs_hooks.cpython-38.pyc and /dev/null differ diff --git a/it/_klipper3d/build-translations.sh b/it/_klipper3d/build-translations.sh deleted file mode 100644 index 4a0117c24..000000000 --- a/it/_klipper3d/build-translations.sh +++ /dev/null @@ -1,84 +0,0 @@ -#!/bin/bash -# This script extracts the Klipper translations and builds multiple -# mdocs sites - one for each supported language. See the README file -# for additional details. - -MKDOCS_DIR="docs/_klipper3d/" -WORK_DIR="work/" -TRANS_DIR="${WORK_DIR}klipper-translations/" -TRANS_FILE="${TRANS_DIR}active_translations" -MKDOCS_MAIN="${MKDOCS_DIR}mkdocs-main.yml" - -# Fetch translations -git clone --depth 1 https://github.com/Klipper3d/klipper-translations ${TRANS_DIR} - -# Create new mkdocs-main.yml with language links -cp ${MKDOCS_DIR}mkdocs.yml ${MKDOCS_MAIN} -while IFS="," read dirname langsite langdesc langsearch; do - sed -i "s%^.*# Alternate language links automatically added here$% - name: ${langdesc}\n link: /${langsite}/\n lang: ${langsite}\n\0%" ${MKDOCS_MAIN} -done < <(egrep -v '^ *(#|$)' ${TRANS_FILE}) - -# Build main English website -echo "building site for en" -mkdocs build -f ${MKDOCS_MAIN} - -# Build each additional language website -while IFS="," read dirname langsite langdesc langsearch; do - new_docs_dir="${WORK_DIR}lang/${langsite}/docs/" - locale_dir="${TRANS_DIR}/docs/locales/${dirname}" - - # read toc - title=$(sed -n '1p' ${locale_dir}/Navigation.md) - installation_and_configuration=$(sed -n '3p' ${locale_dir}/Navigation.md) - configuration_reference=$(sed -n '5p' ${locale_dir}/Navigation.md) - bed_level=$(sed -n '7p' ${locale_dir}/Navigation.md) - resonance_compensation=$(sed -n '9p' ${locale_dir}/Navigation.md) - command_template=$(sed -n '11p' ${locale_dir}/Navigation.md) - developer_documentation=$(sed -n '13p' ${locale_dir}/Navigation.md) - device_specific_documents=$(sed -n '15p' ${locale_dir}/Navigation.md) - - # Copy markdown files to new_docs_dir - echo "Copying $dirname to $langsite" - mkdir -p "${new_docs_dir}" - cp "${locale_dir}"/*.md "${new_docs_dir}" - echo "copy resources" - cp -r docs/img "${new_docs_dir}" - cp -r docs/prints "${new_docs_dir}" - cp -r docs/_klipper3d "${new_docs_dir}" - - # manually replace index.md if a manual-index.md exist - manual_index="${new_docs_dir}manual-index.md" - if [[ -f "${manual_index}" ]]; then - mv -f "${manual_index}" "${new_docs_dir}index.md" - echo "replaced index.md with manual_index.md for $langsite" - else - echo "Manually translated index file for $langsite not found!" - fi - - # Create language specific mkdocs-lang-xxx.yml file - echo "create language specific mkdocs configurations for ${langsite}" - new_mkdocs_file="${new_docs_dir}_klipper3d/mkdocs-lang-${langsite}.yml" - cp "${MKDOCS_MAIN}" "${new_mkdocs_file}" - - echo "replace search language" - sed -i "s%^ lang: en$% lang: ${langsearch}%" "${new_mkdocs_file}" - - echo "replace site language" - sed -i "s%^ language: en$% language: ${langsite}%" "${new_mkdocs_file}" - - echo "replace toc" - sed -i "s%Klipper documentation$%${title}%" "${new_mkdocs_file}" - sed -i "s%Installation and Configuration:$%${installation_and_configuration}:%" "${new_mkdocs_file}" - sed -i "s%Configuration Reference:$%${configuration_reference}:%" "${new_mkdocs_file}" - sed -i "s%Bed Level:$%${bed_level}:%" "${new_mkdocs_file}" - sed -i "s%Resonance Compensation:$%${resonance_compensation}:%" "${new_mkdocs_file}" - sed -i "s%Command templates:$%${command_template}:%" "${new_mkdocs_file}" - sed -i "s%Developer Documentation:$%${developer_documentation}:%" "${new_mkdocs_file}" - sed -i "s%Device Specific Documents:$%${device_specific_documents}:%" "${new_mkdocs_file}" - - # Build site - echo "building site for ${langsite}" - mkdir -p "${PWD}/site/${langsite}/" - ln -sf "${PWD}/site/${langsite}/" "${WORK_DIR}lang/${langsite}/site" - mkdocs build -f "${new_mkdocs_file}" -done < <(egrep -v '^ *(#|$)' ${TRANS_FILE}) diff --git a/it/_klipper3d/css/extra.css b/it/_klipper3d/css/extra.css deleted file mode 100644 index ea57721b0..000000000 --- a/it/_klipper3d/css/extra.css +++ /dev/null @@ -1,16 +0,0 @@ -/* Customization of mkdocs generated site */ -[data-md-color-scheme="slate"] { - --md-primary-fg-color: hsla(var(--md-hue),15%,12%,1); - --md-default-bg-color: hsla(var(--md-hue),17%,17%,1); - --md-typeset-a-color: steelblue; - --md-accent-fg-color: lightblue; -} - -img { - background-color: white; -} - -.center-image { - margin: 0 auto; - display: block; -} diff --git a/it/_klipper3d/mkdocs-lang-it.yml b/it/_klipper3d/mkdocs-lang-it.yml deleted file mode 100644 index 48401d44b..000000000 --- a/it/_klipper3d/mkdocs-lang-it.yml +++ /dev/null @@ -1,160 +0,0 @@ -# Main configuration file for mkdocs generation of klipper3d.org website - -# Note that the build-translations.sh script expects a certain file -# layout. See that script and the README file for more details. - -# Site and directory configuration -site_name: Documentazione Klipper -repo_url: https://github.com/Klipper3d/klipper -repo_name: Klipper3d/klipper -edit_uri: blob/master/docs/ -use_directory_urls: False -docs_dir: '../' -site_dir: '../../site/' - -# Custom markdown dialect settings -markdown_extensions: - - toc: - permalink: True - toc_depth: 6 - - attr_list - - mdx_partial_gfm - - mdx_truly_sane_lists - - mdx_breakless_lists -plugins: - search: - lang: it - mkdocs-simple-hooks: - hooks: - on_page_markdown: "docs._klipper3d.mkdocs_hooks:transform" - exclude: - glob: "README.md" - -# Website layout configuration (using mkdocs-material theme) -theme: - name: material - palette: - - media: "(prefers-color-scheme: light)" - scheme: default - primary: white - accent: blue - toggle: - icon: material/lightbulb - name: Switch to dark mode - - media: "(prefers-color-scheme: dark)" - scheme: slate - primary: grey - accent: light blue - toggle: - icon: material/lightbulb-outline - name: Switch to light mode - logo: img/klipper.svg - favicon: img/favicon.ico - icon: - repo: fontawesome/brands/github - alternate: material/web - features: - #- navigation.tabs - #- navigation.expand - - navigation.top - # if enabled, the TOC doesn't work for some pages - # - toc.integrate - - search.suggest - - search.highlight - - search.share - language: it -extra_css: - - _klipper3d/css/extra.css - -# Site usage statistics -extra: - # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#site-search-tracking - analytics: - provider: google - property: G-VEN1PGNQL4 - # Language Selection - alternate: - - name: English - link: / - lang: en - - name: 简体中文 - link: /zh/ - lang: zh - - name: 繁體中文 - link: /zh-Hant/ - lang: zh-Hant - - name: Magyar - link: /hu/ - lang: hu - - name: Italiano - link: /it/ - lang: it - - name: Français - link: /fr/ - lang: fr - # Alternate language links automatically added here - -# Navigation hierarchy (this should mimic the layout of Overview.md) -nav: - - Overview.md - - Features.md - - FAQ.md - - Releases.md - - Config_Changes.md - - Contact.md - - Installazione e configurazione: - - Installation: - - Installation.md - - OctoPrint.md - - Riferimenti di configurazione: - - Config_Reference.md - - Rotation_Distance.md - - Config_checks.md - - Livello del piatto: - - Bed_Level.md - - Delta_Calibrate.md - - Probe_Calibrate.md - - BLTouch.md - - Manual_Level.md - - Bed_Mesh.md - - Endstop_Phase.md - - Axis_Twist_Compensation.md - - Compensazione della risonanza: - - Resonance_Compensation.md - - Measuring_Resonances.md - - Pressure_Advance.md - - G-Codes.md - - Template dei comandi: - - Command_Templates.md - - Status_Reference.md - - TMC_Drivers.md - - Multi_MCU_Homing.md - - Slicers.md - - Skew_Correction.md - - Exclude_Object.md - - Using_PWM_Tools.md - - Documentazione per sviluppatori: - - Code_Overview.md - - Kinematics.md - - Protocol.md - - API_Server.md - - MCU_Commands.md - - CANBUS_protocol.md - - Debugging.md - - Benchmarks.md - - CONTRIBUTING.md - - Packaging.md - - Documenti specifici del dispositivo: - - Example_Configs.md - - SDCard_Updates.md - - RPi_microcontroller.md - - Beaglebone.md - - Bootloaders.md - - Bootloader_Entry.md - - CANBUS.md - - CANBUS_Troubleshooting.md - - TSL1401CL_Filament_Width_Sensor.md - - Hall_Filament_Width_Sensor.md - - Eddy_Probe.md - - Load_Cell.md - - Sponsors.md diff --git a/it/_klipper3d/mkdocs-main.yml b/it/_klipper3d/mkdocs-main.yml deleted file mode 100644 index 896865dd1..000000000 --- a/it/_klipper3d/mkdocs-main.yml +++ /dev/null @@ -1,160 +0,0 @@ -# Main configuration file for mkdocs generation of klipper3d.org website - -# Note that the build-translations.sh script expects a certain file -# layout. See that script and the README file for more details. - -# Site and directory configuration -site_name: Klipper documentation -repo_url: https://github.com/Klipper3d/klipper -repo_name: Klipper3d/klipper -edit_uri: blob/master/docs/ -use_directory_urls: False -docs_dir: '../' -site_dir: '../../site/' - -# Custom markdown dialect settings -markdown_extensions: - - toc: - permalink: True - toc_depth: 6 - - attr_list - - mdx_partial_gfm - - mdx_truly_sane_lists - - mdx_breakless_lists -plugins: - search: - lang: en - mkdocs-simple-hooks: - hooks: - on_page_markdown: "docs._klipper3d.mkdocs_hooks:transform" - exclude: - glob: "README.md" - -# Website layout configuration (using mkdocs-material theme) -theme: - name: material - palette: - - media: "(prefers-color-scheme: light)" - scheme: default - primary: white - accent: blue - toggle: - icon: material/lightbulb - name: Switch to dark mode - - media: "(prefers-color-scheme: dark)" - scheme: slate - primary: grey - accent: light blue - toggle: - icon: material/lightbulb-outline - name: Switch to light mode - logo: img/klipper.svg - favicon: img/favicon.ico - icon: - repo: fontawesome/brands/github - alternate: material/web - features: - #- navigation.tabs - #- navigation.expand - - navigation.top - # if enabled, the TOC doesn't work for some pages - # - toc.integrate - - search.suggest - - search.highlight - - search.share - language: en -extra_css: - - _klipper3d/css/extra.css - -# Site usage statistics -extra: - # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#site-search-tracking - analytics: - provider: google - property: G-VEN1PGNQL4 - # Language Selection - alternate: - - name: English - link: / - lang: en - - name: 简体中文 - link: /zh/ - lang: zh - - name: 繁體中文 - link: /zh-Hant/ - lang: zh-Hant - - name: Magyar - link: /hu/ - lang: hu - - name: Italiano - link: /it/ - lang: it - - name: Français - link: /fr/ - lang: fr - # Alternate language links automatically added here - -# Navigation hierarchy (this should mimic the layout of Overview.md) -nav: - - Overview.md - - Features.md - - FAQ.md - - Releases.md - - Config_Changes.md - - Contact.md - - Installation and Configuration: - - Installation: - - Installation.md - - OctoPrint.md - - Configuration Reference: - - Config_Reference.md - - Rotation_Distance.md - - Config_checks.md - - Bed Level: - - Bed_Level.md - - Delta_Calibrate.md - - Probe_Calibrate.md - - BLTouch.md - - Manual_Level.md - - Bed_Mesh.md - - Endstop_Phase.md - - Axis_Twist_Compensation.md - - Resonance Compensation: - - Resonance_Compensation.md - - Measuring_Resonances.md - - Pressure_Advance.md - - G-Codes.md - - Command templates: - - Command_Templates.md - - Status_Reference.md - - TMC_Drivers.md - - Multi_MCU_Homing.md - - Slicers.md - - Skew_Correction.md - - Exclude_Object.md - - Using_PWM_Tools.md - - Developer Documentation: - - Code_Overview.md - - Kinematics.md - - Protocol.md - - API_Server.md - - MCU_Commands.md - - CANBUS_protocol.md - - Debugging.md - - Benchmarks.md - - CONTRIBUTING.md - - Packaging.md - - Device Specific Documents: - - Example_Configs.md - - SDCard_Updates.md - - RPi_microcontroller.md - - Beaglebone.md - - Bootloaders.md - - Bootloader_Entry.md - - CANBUS.md - - CANBUS_Troubleshooting.md - - TSL1401CL_Filament_Width_Sensor.md - - Hall_Filament_Width_Sensor.md - - Eddy_Probe.md - - Load_Cell.md - - Sponsors.md diff --git a/it/_klipper3d/mkdocs-requirements.txt b/it/_klipper3d/mkdocs-requirements.txt deleted file mode 100644 index 806ec0106..000000000 --- a/it/_klipper3d/mkdocs-requirements.txt +++ /dev/null @@ -1,10 +0,0 @@ -# Python virtualenv module requirements for mkdocs -jinja2==3.1.6 -mkdocs==1.2.4 -mkdocs-material==8.1.3 -mkdocs-simple-hooks==0.1.3 -mkdocs-exclude==1.0.2 -mdx-truly-sane-lists==1.2 -mdx-breakless-lists==1.0.1 -py-gfm==1.0.2 -markdown==3.3.7 diff --git a/it/_klipper3d/mkdocs.yml b/it/_klipper3d/mkdocs.yml deleted file mode 100644 index e13fbe8de..000000000 --- a/it/_klipper3d/mkdocs.yml +++ /dev/null @@ -1,145 +0,0 @@ -# Main configuration file for mkdocs generation of klipper3d.org website - -# Note that the build-translations.sh script expects a certain file -# layout. See that script and the README file for more details. - -# Site and directory configuration -site_name: Klipper documentation -repo_url: https://github.com/Klipper3d/klipper -repo_name: Klipper3d/klipper -edit_uri: blob/master/docs/ -use_directory_urls: False -docs_dir: '../' -site_dir: '../../site/' - -# Custom markdown dialect settings -markdown_extensions: - - toc: - permalink: True - toc_depth: 6 - - attr_list - - mdx_partial_gfm - - mdx_truly_sane_lists - - mdx_breakless_lists -plugins: - search: - lang: en - mkdocs-simple-hooks: - hooks: - on_page_markdown: "docs._klipper3d.mkdocs_hooks:transform" - exclude: - glob: "README.md" - -# Website layout configuration (using mkdocs-material theme) -theme: - name: material - palette: - - media: "(prefers-color-scheme: light)" - scheme: default - primary: white - accent: blue - toggle: - icon: material/lightbulb - name: Switch to dark mode - - media: "(prefers-color-scheme: dark)" - scheme: slate - primary: grey - accent: light blue - toggle: - icon: material/lightbulb-outline - name: Switch to light mode - logo: img/klipper.svg - favicon: img/favicon.ico - icon: - repo: fontawesome/brands/github - alternate: material/web - features: - #- navigation.tabs - #- navigation.expand - - navigation.top - # if enabled, the TOC doesn't work for some pages - # - toc.integrate - - search.suggest - - search.highlight - - search.share - language: en -extra_css: - - _klipper3d/css/extra.css - -# Site usage statistics -extra: - # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#site-search-tracking - analytics: - provider: google - property: G-VEN1PGNQL4 - # Language Selection - alternate: - - name: English - link: / - lang: en - # Alternate language links automatically added here - -# Navigation hierarchy (this should mimic the layout of Overview.md) -nav: - - Overview.md - - Features.md - - FAQ.md - - Releases.md - - Config_Changes.md - - Contact.md - - Installation and Configuration: - - Installation: - - Installation.md - - OctoPrint.md - - Configuration Reference: - - Config_Reference.md - - Rotation_Distance.md - - Config_checks.md - - Bed Level: - - Bed_Level.md - - Delta_Calibrate.md - - Probe_Calibrate.md - - BLTouch.md - - Manual_Level.md - - Bed_Mesh.md - - Endstop_Phase.md - - Axis_Twist_Compensation.md - - Resonance Compensation: - - Resonance_Compensation.md - - Measuring_Resonances.md - - Pressure_Advance.md - - G-Codes.md - - Command templates: - - Command_Templates.md - - Status_Reference.md - - TMC_Drivers.md - - Multi_MCU_Homing.md - - Slicers.md - - Skew_Correction.md - - Exclude_Object.md - - Using_PWM_Tools.md - - Developer Documentation: - - Code_Overview.md - - Kinematics.md - - Protocol.md - - API_Server.md - - MCU_Commands.md - - CANBUS_protocol.md - - Debugging.md - - Benchmarks.md - - CONTRIBUTING.md - - Packaging.md - - Device Specific Documents: - - Example_Configs.md - - SDCard_Updates.md - - RPi_microcontroller.md - - Beaglebone.md - - Bootloaders.md - - Bootloader_Entry.md - - CANBUS.md - - CANBUS_Troubleshooting.md - - TSL1401CL_Filament_Width_Sensor.md - - Hall_Filament_Width_Sensor.md - - Eddy_Probe.md - - Load_Cell.md - - Sponsors.md diff --git a/it/_klipper3d/mkdocs_hooks.py b/it/_klipper3d/mkdocs_hooks.py deleted file mode 100644 index 396832c44..000000000 --- a/it/_klipper3d/mkdocs_hooks.py +++ /dev/null @@ -1,42 +0,0 @@ -# Tool to customize conversion of markdown files during mkdocs site generation -import re -import logging - -# This script translates some github specific markdown formatting to -# improve rendering with mkdocs. The goal is for pages to render -# similarly on both github and the web site. It has three main tasks: -# 1. Convert links outside of the docs directory (any reference -# starting with "../") to an absolute link to the raw file on -# github. -# 2. Convert a trailing backslash on a text line to a "
". -# 3. Remove leading spaces from top-level lists so that those lists -# are rendered correctly. - -logger = logging.getLogger('mkdocs.mkdocs_hooks.transform') - -def transform(markdown: str, page, config, files): - in_code_block = 0 - in_list = False - lines = markdown.splitlines() - for i in range(len(lines)): - line_out = lines[i] - in_code_block = (in_code_block + - len(re.findall("\s*[`]{3,}", line_out))) % 2 - if not in_code_block: - line_out = line_out.replace('](../', - f"]({config['repo_url']}blob/master/") - line_out = re.sub("\\\s*$", "
", line_out) - # check that lists at level 0 are not indented - # (no space before *|-|1.) - if re.match(r"^[^-*0-9 ]", line_out): - in_list = False - elif re.match(r"^(\*|-|\d+\.) ", line_out): - in_list = True - if not in_list: - line_out = re.sub(r"^\s+(\*|-|\d+\.) ", r"\1 ", line_out) - if line_out != lines[i]: - logger.debug((f'[mkdocs_hooks] rewrite line {i+1}: ' - f'"{lines[i]}" -> "{line_out}"')) - lines[i] = line_out - output = "\n".join(lines) - return output diff --git a/it/sitemap.xml b/it/sitemap.xml deleted file mode 100644 index 0809d3a19..000000000 --- a/it/sitemap.xml +++ /dev/null @@ -1,283 +0,0 @@ - - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - \ No newline at end of file diff --git a/it/sitemap.xml.gz b/it/sitemap.xml.gz deleted file mode 100644 index b9854a24a..000000000 Binary files a/it/sitemap.xml.gz and /dev/null differ diff --git a/sitemap.xml b/sitemap.xml deleted file mode 100644 index 7bd5a798d..000000000 --- a/sitemap.xml +++ /dev/null @@ -1,278 +0,0 @@ - - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - \ No newline at end of file diff --git a/sitemap.xml.gz b/sitemap.xml.gz deleted file mode 100644 index ec42a7c8f..000000000 Binary files a/sitemap.xml.gz and /dev/null differ diff --git a/zh-Hant/_klipper3d/README b/zh-Hant/_klipper3d/README deleted file mode 100644 index df91f2d9f..000000000 --- a/zh-Hant/_klipper3d/README +++ /dev/null @@ -1,20 +0,0 @@ -This directory defines the https://www.klipper3d.org/ website. The -site is hosted using "github pages". The -.github/workflows/klipper3d-deploy.yaml tool uses mkdocs ( -https://www.mkdocs.org/ ) to automatically convert the markdown files -in the docs/ directory to html. In addition to the files in this -directory, the docs/CNAME file also controls the website generation. - -To test deploy the main English site locally one can use commands -similar to the following: - -virtualenv ~/mkdocs-env && ~/mkdocs-env/bin/pip install -r ~/klipper/docs/_klipper3d/mkdocs-requirements.txt -cd ~/klipper && ~/mkdocs-env/bin/mkdocs serve --config-file ~/klipper/docs/_klipper3d/mkdocs.yml -a 0.0.0.0:8000 - -To test deploy the multi-language site locally one can use commands -similar to the following: - -virtualenv ~/mkdocs-env && ~/mkdocs-env/bin/pip install -r ~/klipper/docs/_klipper3d/mkdocs-requirements.txt -source ~/mkdocs-env/bin/activate -cd ~/klipper && ./docs/_klipper3d/build-translations.sh -cd ~/klipper/site/ && python3 -m http.server 8000 diff --git a/zh-Hant/_klipper3d/__pycache__/mkdocs_hooks.cpython-38.pyc b/zh-Hant/_klipper3d/__pycache__/mkdocs_hooks.cpython-38.pyc deleted file mode 100644 index 221e8754c..000000000 Binary files a/zh-Hant/_klipper3d/__pycache__/mkdocs_hooks.cpython-38.pyc and /dev/null differ diff --git a/zh-Hant/_klipper3d/build-translations.sh b/zh-Hant/_klipper3d/build-translations.sh deleted file mode 100644 index 4a0117c24..000000000 --- a/zh-Hant/_klipper3d/build-translations.sh +++ /dev/null @@ -1,84 +0,0 @@ -#!/bin/bash -# This script extracts the Klipper translations and builds multiple -# mdocs sites - one for each supported language. See the README file -# for additional details. - -MKDOCS_DIR="docs/_klipper3d/" -WORK_DIR="work/" -TRANS_DIR="${WORK_DIR}klipper-translations/" -TRANS_FILE="${TRANS_DIR}active_translations" -MKDOCS_MAIN="${MKDOCS_DIR}mkdocs-main.yml" - -# Fetch translations -git clone --depth 1 https://github.com/Klipper3d/klipper-translations ${TRANS_DIR} - -# Create new mkdocs-main.yml with language links -cp ${MKDOCS_DIR}mkdocs.yml ${MKDOCS_MAIN} -while IFS="," read dirname langsite langdesc langsearch; do - sed -i "s%^.*# Alternate language links automatically added here$% - name: ${langdesc}\n link: /${langsite}/\n lang: ${langsite}\n\0%" ${MKDOCS_MAIN} -done < <(egrep -v '^ *(#|$)' ${TRANS_FILE}) - -# Build main English website -echo "building site for en" -mkdocs build -f ${MKDOCS_MAIN} - -# Build each additional language website -while IFS="," read dirname langsite langdesc langsearch; do - new_docs_dir="${WORK_DIR}lang/${langsite}/docs/" - locale_dir="${TRANS_DIR}/docs/locales/${dirname}" - - # read toc - title=$(sed -n '1p' ${locale_dir}/Navigation.md) - installation_and_configuration=$(sed -n '3p' ${locale_dir}/Navigation.md) - configuration_reference=$(sed -n '5p' ${locale_dir}/Navigation.md) - bed_level=$(sed -n '7p' ${locale_dir}/Navigation.md) - resonance_compensation=$(sed -n '9p' ${locale_dir}/Navigation.md) - command_template=$(sed -n '11p' ${locale_dir}/Navigation.md) - developer_documentation=$(sed -n '13p' ${locale_dir}/Navigation.md) - device_specific_documents=$(sed -n '15p' ${locale_dir}/Navigation.md) - - # Copy markdown files to new_docs_dir - echo "Copying $dirname to $langsite" - mkdir -p "${new_docs_dir}" - cp "${locale_dir}"/*.md "${new_docs_dir}" - echo "copy resources" - cp -r docs/img "${new_docs_dir}" - cp -r docs/prints "${new_docs_dir}" - cp -r docs/_klipper3d "${new_docs_dir}" - - # manually replace index.md if a manual-index.md exist - manual_index="${new_docs_dir}manual-index.md" - if [[ -f "${manual_index}" ]]; then - mv -f "${manual_index}" "${new_docs_dir}index.md" - echo "replaced index.md with manual_index.md for $langsite" - else - echo "Manually translated index file for $langsite not found!" - fi - - # Create language specific mkdocs-lang-xxx.yml file - echo "create language specific mkdocs configurations for ${langsite}" - new_mkdocs_file="${new_docs_dir}_klipper3d/mkdocs-lang-${langsite}.yml" - cp "${MKDOCS_MAIN}" "${new_mkdocs_file}" - - echo "replace search language" - sed -i "s%^ lang: en$% lang: ${langsearch}%" "${new_mkdocs_file}" - - echo "replace site language" - sed -i "s%^ language: en$% language: ${langsite}%" "${new_mkdocs_file}" - - echo "replace toc" - sed -i "s%Klipper documentation$%${title}%" "${new_mkdocs_file}" - sed -i "s%Installation and Configuration:$%${installation_and_configuration}:%" "${new_mkdocs_file}" - sed -i "s%Configuration Reference:$%${configuration_reference}:%" "${new_mkdocs_file}" - sed -i "s%Bed Level:$%${bed_level}:%" "${new_mkdocs_file}" - sed -i "s%Resonance Compensation:$%${resonance_compensation}:%" "${new_mkdocs_file}" - sed -i "s%Command templates:$%${command_template}:%" "${new_mkdocs_file}" - sed -i "s%Developer Documentation:$%${developer_documentation}:%" "${new_mkdocs_file}" - sed -i "s%Device Specific Documents:$%${device_specific_documents}:%" "${new_mkdocs_file}" - - # Build site - echo "building site for ${langsite}" - mkdir -p "${PWD}/site/${langsite}/" - ln -sf "${PWD}/site/${langsite}/" "${WORK_DIR}lang/${langsite}/site" - mkdocs build -f "${new_mkdocs_file}" -done < <(egrep -v '^ *(#|$)' ${TRANS_FILE}) diff --git a/zh-Hant/_klipper3d/css/extra.css b/zh-Hant/_klipper3d/css/extra.css deleted file mode 100644 index ea57721b0..000000000 --- a/zh-Hant/_klipper3d/css/extra.css +++ /dev/null @@ -1,16 +0,0 @@ -/* Customization of mkdocs generated site */ -[data-md-color-scheme="slate"] { - --md-primary-fg-color: hsla(var(--md-hue),15%,12%,1); - --md-default-bg-color: hsla(var(--md-hue),17%,17%,1); - --md-typeset-a-color: steelblue; - --md-accent-fg-color: lightblue; -} - -img { - background-color: white; -} - -.center-image { - margin: 0 auto; - display: block; -} diff --git a/zh-Hant/_klipper3d/mkdocs-lang-zh-Hant.yml b/zh-Hant/_klipper3d/mkdocs-lang-zh-Hant.yml deleted file mode 100644 index f640fadcf..000000000 --- a/zh-Hant/_klipper3d/mkdocs-lang-zh-Hant.yml +++ /dev/null @@ -1,160 +0,0 @@ -# Main configuration file for mkdocs generation of klipper3d.org website - -# Note that the build-translations.sh script expects a certain file -# layout. See that script and the README file for more details. - -# Site and directory configuration -site_name: Klipper 文檔 -repo_url: https://github.com/Klipper3d/klipper -repo_name: Klipper3d/klipper -edit_uri: blob/master/docs/ -use_directory_urls: False -docs_dir: '../' -site_dir: '../../site/' - -# Custom markdown dialect settings -markdown_extensions: - - toc: - permalink: True - toc_depth: 6 - - attr_list - - mdx_partial_gfm - - mdx_truly_sane_lists - - mdx_breakless_lists -plugins: - search: - lang: ja - mkdocs-simple-hooks: - hooks: - on_page_markdown: "docs._klipper3d.mkdocs_hooks:transform" - exclude: - glob: "README.md" - -# Website layout configuration (using mkdocs-material theme) -theme: - name: material - palette: - - media: "(prefers-color-scheme: light)" - scheme: default - primary: white - accent: blue - toggle: - icon: material/lightbulb - name: Switch to dark mode - - media: "(prefers-color-scheme: dark)" - scheme: slate - primary: grey - accent: light blue - toggle: - icon: material/lightbulb-outline - name: Switch to light mode - logo: img/klipper.svg - favicon: img/favicon.ico - icon: - repo: fontawesome/brands/github - alternate: material/web - features: - #- navigation.tabs - #- navigation.expand - - navigation.top - # if enabled, the TOC doesn't work for some pages - # - toc.integrate - - search.suggest - - search.highlight - - search.share - language: zh-Hant -extra_css: - - _klipper3d/css/extra.css - -# Site usage statistics -extra: - # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#site-search-tracking - analytics: - provider: google - property: G-VEN1PGNQL4 - # Language Selection - alternate: - - name: English - link: / - lang: en - - name: 简体中文 - link: /zh/ - lang: zh - - name: 繁體中文 - link: /zh-Hant/ - lang: zh-Hant - - name: Magyar - link: /hu/ - lang: hu - - name: Italiano - link: /it/ - lang: it - - name: Français - link: /fr/ - lang: fr - # Alternate language links automatically added here - -# Navigation hierarchy (this should mimic the layout of Overview.md) -nav: - - Overview.md - - Features.md - - FAQ.md - - Releases.md - - Config_Changes.md - - Contact.md - - 安裝和配置: - - Installation: - - Installation.md - - OctoPrint.md - - 配置參考: - - Config_Reference.md - - Rotation_Distance.md - - Config_checks.md - - 印床水平: - - Bed_Level.md - - Delta_Calibrate.md - - Probe_Calibrate.md - - BLTouch.md - - Manual_Level.md - - Bed_Mesh.md - - Endstop_Phase.md - - Axis_Twist_Compensation.md - - 共振補償: - - Resonance_Compensation.md - - Measuring_Resonances.md - - Pressure_Advance.md - - G-Codes.md - - 命令模板: - - Command_Templates.md - - Status_Reference.md - - TMC_Drivers.md - - Multi_MCU_Homing.md - - Slicers.md - - Skew_Correction.md - - Exclude_Object.md - - Using_PWM_Tools.md - - 開發者文檔: - - Code_Overview.md - - Kinematics.md - - Protocol.md - - API_Server.md - - MCU_Commands.md - - CANBUS_protocol.md - - Debugging.md - - Benchmarks.md - - CONTRIBUTING.md - - Packaging.md - - 設備特定文件: - - Example_Configs.md - - SDCard_Updates.md - - RPi_microcontroller.md - - Beaglebone.md - - Bootloaders.md - - Bootloader_Entry.md - - CANBUS.md - - CANBUS_Troubleshooting.md - - TSL1401CL_Filament_Width_Sensor.md - - Hall_Filament_Width_Sensor.md - - Eddy_Probe.md - - Load_Cell.md - - Sponsors.md diff --git a/zh-Hant/_klipper3d/mkdocs-main.yml b/zh-Hant/_klipper3d/mkdocs-main.yml deleted file mode 100644 index 896865dd1..000000000 --- a/zh-Hant/_klipper3d/mkdocs-main.yml +++ /dev/null @@ -1,160 +0,0 @@ -# Main configuration file for mkdocs generation of klipper3d.org website - -# Note that the build-translations.sh script expects a certain file -# layout. See that script and the README file for more details. - -# Site and directory configuration -site_name: Klipper documentation -repo_url: https://github.com/Klipper3d/klipper -repo_name: Klipper3d/klipper -edit_uri: blob/master/docs/ -use_directory_urls: False -docs_dir: '../' -site_dir: '../../site/' - -# Custom markdown dialect settings -markdown_extensions: - - toc: - permalink: True - toc_depth: 6 - - attr_list - - mdx_partial_gfm - - mdx_truly_sane_lists - - mdx_breakless_lists -plugins: - search: - lang: en - mkdocs-simple-hooks: - hooks: - on_page_markdown: "docs._klipper3d.mkdocs_hooks:transform" - exclude: - glob: "README.md" - -# Website layout configuration (using mkdocs-material theme) -theme: - name: material - palette: - - media: "(prefers-color-scheme: light)" - scheme: default - primary: white - accent: blue - toggle: - icon: material/lightbulb - name: Switch to dark mode - - media: "(prefers-color-scheme: dark)" - scheme: slate - primary: grey - accent: light blue - toggle: - icon: material/lightbulb-outline - name: Switch to light mode - logo: img/klipper.svg - favicon: img/favicon.ico - icon: - repo: fontawesome/brands/github - alternate: material/web - features: - #- navigation.tabs - #- navigation.expand - - navigation.top - # if enabled, the TOC doesn't work for some pages - # - toc.integrate - - search.suggest - - search.highlight - - search.share - language: en -extra_css: - - _klipper3d/css/extra.css - -# Site usage statistics -extra: - # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#site-search-tracking - analytics: - provider: google - property: G-VEN1PGNQL4 - # Language Selection - alternate: - - name: English - link: / - lang: en - - name: 简体中文 - link: /zh/ - lang: zh - - name: 繁體中文 - link: /zh-Hant/ - lang: zh-Hant - - name: Magyar - link: /hu/ - lang: hu - - name: Italiano - link: /it/ - lang: it - - name: Français - link: /fr/ - lang: fr - # Alternate language links automatically added here - -# Navigation hierarchy (this should mimic the layout of Overview.md) -nav: - - Overview.md - - Features.md - - FAQ.md - - Releases.md - - Config_Changes.md - - Contact.md - - Installation and Configuration: - - Installation: - - Installation.md - - OctoPrint.md - - Configuration Reference: - - Config_Reference.md - - Rotation_Distance.md - - Config_checks.md - - Bed Level: - - Bed_Level.md - - Delta_Calibrate.md - - Probe_Calibrate.md - - BLTouch.md - - Manual_Level.md - - Bed_Mesh.md - - Endstop_Phase.md - - Axis_Twist_Compensation.md - - Resonance Compensation: - - Resonance_Compensation.md - - Measuring_Resonances.md - - Pressure_Advance.md - - G-Codes.md - - Command templates: - - Command_Templates.md - - Status_Reference.md - - TMC_Drivers.md - - Multi_MCU_Homing.md - - Slicers.md - - Skew_Correction.md - - Exclude_Object.md - - Using_PWM_Tools.md - - Developer Documentation: - - Code_Overview.md - - Kinematics.md - - Protocol.md - - API_Server.md - - MCU_Commands.md - - CANBUS_protocol.md - - Debugging.md - - Benchmarks.md - - CONTRIBUTING.md - - Packaging.md - - Device Specific Documents: - - Example_Configs.md - - SDCard_Updates.md - - RPi_microcontroller.md - - Beaglebone.md - - Bootloaders.md - - Bootloader_Entry.md - - CANBUS.md - - CANBUS_Troubleshooting.md - - TSL1401CL_Filament_Width_Sensor.md - - Hall_Filament_Width_Sensor.md - - Eddy_Probe.md - - Load_Cell.md - - Sponsors.md diff --git a/zh-Hant/_klipper3d/mkdocs-requirements.txt b/zh-Hant/_klipper3d/mkdocs-requirements.txt deleted file mode 100644 index 806ec0106..000000000 --- a/zh-Hant/_klipper3d/mkdocs-requirements.txt +++ /dev/null @@ -1,10 +0,0 @@ -# Python virtualenv module requirements for mkdocs -jinja2==3.1.6 -mkdocs==1.2.4 -mkdocs-material==8.1.3 -mkdocs-simple-hooks==0.1.3 -mkdocs-exclude==1.0.2 -mdx-truly-sane-lists==1.2 -mdx-breakless-lists==1.0.1 -py-gfm==1.0.2 -markdown==3.3.7 diff --git a/zh-Hant/_klipper3d/mkdocs.yml b/zh-Hant/_klipper3d/mkdocs.yml deleted file mode 100644 index e13fbe8de..000000000 --- a/zh-Hant/_klipper3d/mkdocs.yml +++ /dev/null @@ -1,145 +0,0 @@ -# Main configuration file for mkdocs generation of klipper3d.org website - -# Note that the build-translations.sh script expects a certain file -# layout. See that script and the README file for more details. - -# Site and directory configuration -site_name: Klipper documentation -repo_url: https://github.com/Klipper3d/klipper -repo_name: Klipper3d/klipper -edit_uri: blob/master/docs/ -use_directory_urls: False -docs_dir: '../' -site_dir: '../../site/' - -# Custom markdown dialect settings -markdown_extensions: - - toc: - permalink: True - toc_depth: 6 - - attr_list - - mdx_partial_gfm - - mdx_truly_sane_lists - - mdx_breakless_lists -plugins: - search: - lang: en - mkdocs-simple-hooks: - hooks: - on_page_markdown: "docs._klipper3d.mkdocs_hooks:transform" - exclude: - glob: "README.md" - -# Website layout configuration (using mkdocs-material theme) -theme: - name: material - palette: - - media: "(prefers-color-scheme: light)" - scheme: default - primary: white - accent: blue - toggle: - icon: material/lightbulb - name: Switch to dark mode - - media: "(prefers-color-scheme: dark)" - scheme: slate - primary: grey - accent: light blue - toggle: - icon: material/lightbulb-outline - name: Switch to light mode - logo: img/klipper.svg - favicon: img/favicon.ico - icon: - repo: fontawesome/brands/github - alternate: material/web - features: - #- navigation.tabs - #- navigation.expand - - navigation.top - # if enabled, the TOC doesn't work for some pages - # - toc.integrate - - search.suggest - - search.highlight - - search.share - language: en -extra_css: - - _klipper3d/css/extra.css - -# Site usage statistics -extra: - # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#site-search-tracking - analytics: - provider: google - property: G-VEN1PGNQL4 - # Language Selection - alternate: - - name: English - link: / - lang: en - # Alternate language links automatically added here - -# Navigation hierarchy (this should mimic the layout of Overview.md) -nav: - - Overview.md - - Features.md - - FAQ.md - - Releases.md - - Config_Changes.md - - Contact.md - - Installation and Configuration: - - Installation: - - Installation.md - - OctoPrint.md - - Configuration Reference: - - Config_Reference.md - - Rotation_Distance.md - - Config_checks.md - - Bed Level: - - Bed_Level.md - - Delta_Calibrate.md - - Probe_Calibrate.md - - BLTouch.md - - Manual_Level.md - - Bed_Mesh.md - - Endstop_Phase.md - - Axis_Twist_Compensation.md - - Resonance Compensation: - - Resonance_Compensation.md - - Measuring_Resonances.md - - Pressure_Advance.md - - G-Codes.md - - Command templates: - - Command_Templates.md - - Status_Reference.md - - TMC_Drivers.md - - Multi_MCU_Homing.md - - Slicers.md - - Skew_Correction.md - - Exclude_Object.md - - Using_PWM_Tools.md - - Developer Documentation: - - Code_Overview.md - - Kinematics.md - - Protocol.md - - API_Server.md - - MCU_Commands.md - - CANBUS_protocol.md - - Debugging.md - - Benchmarks.md - - CONTRIBUTING.md - - Packaging.md - - Device Specific Documents: - - Example_Configs.md - - SDCard_Updates.md - - RPi_microcontroller.md - - Beaglebone.md - - Bootloaders.md - - Bootloader_Entry.md - - CANBUS.md - - CANBUS_Troubleshooting.md - - TSL1401CL_Filament_Width_Sensor.md - - Hall_Filament_Width_Sensor.md - - Eddy_Probe.md - - Load_Cell.md - - Sponsors.md diff --git a/zh-Hant/_klipper3d/mkdocs_hooks.py b/zh-Hant/_klipper3d/mkdocs_hooks.py deleted file mode 100644 index 396832c44..000000000 --- a/zh-Hant/_klipper3d/mkdocs_hooks.py +++ /dev/null @@ -1,42 +0,0 @@ -# Tool to customize conversion of markdown files during mkdocs site generation -import re -import logging - -# This script translates some github specific markdown formatting to -# improve rendering with mkdocs. The goal is for pages to render -# similarly on both github and the web site. It has three main tasks: -# 1. Convert links outside of the docs directory (any reference -# starting with "../") to an absolute link to the raw file on -# github. -# 2. Convert a trailing backslash on a text line to a "
". -# 3. Remove leading spaces from top-level lists so that those lists -# are rendered correctly. - -logger = logging.getLogger('mkdocs.mkdocs_hooks.transform') - -def transform(markdown: str, page, config, files): - in_code_block = 0 - in_list = False - lines = markdown.splitlines() - for i in range(len(lines)): - line_out = lines[i] - in_code_block = (in_code_block + - len(re.findall("\s*[`]{3,}", line_out))) % 2 - if not in_code_block: - line_out = line_out.replace('](../', - f"]({config['repo_url']}blob/master/") - line_out = re.sub("\\\s*$", "
", line_out) - # check that lists at level 0 are not indented - # (no space before *|-|1.) - if re.match(r"^[^-*0-9 ]", line_out): - in_list = False - elif re.match(r"^(\*|-|\d+\.) ", line_out): - in_list = True - if not in_list: - line_out = re.sub(r"^\s+(\*|-|\d+\.) ", r"\1 ", line_out) - if line_out != lines[i]: - logger.debug((f'[mkdocs_hooks] rewrite line {i+1}: ' - f'"{lines[i]}" -> "{line_out}"')) - lines[i] = line_out - output = "\n".join(lines) - return output diff --git a/zh-Hant/sitemap.xml b/zh-Hant/sitemap.xml deleted file mode 100644 index 0809d3a19..000000000 --- a/zh-Hant/sitemap.xml +++ /dev/null @@ -1,283 +0,0 @@ - - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - \ No newline at end of file diff --git a/zh-Hant/sitemap.xml.gz b/zh-Hant/sitemap.xml.gz deleted file mode 100644 index 5edb1445e..000000000 Binary files a/zh-Hant/sitemap.xml.gz and /dev/null differ diff --git a/zh/_klipper3d/README b/zh/_klipper3d/README deleted file mode 100644 index df91f2d9f..000000000 --- a/zh/_klipper3d/README +++ /dev/null @@ -1,20 +0,0 @@ -This directory defines the https://www.klipper3d.org/ website. The -site is hosted using "github pages". The -.github/workflows/klipper3d-deploy.yaml tool uses mkdocs ( -https://www.mkdocs.org/ ) to automatically convert the markdown files -in the docs/ directory to html. In addition to the files in this -directory, the docs/CNAME file also controls the website generation. - -To test deploy the main English site locally one can use commands -similar to the following: - -virtualenv ~/mkdocs-env && ~/mkdocs-env/bin/pip install -r ~/klipper/docs/_klipper3d/mkdocs-requirements.txt -cd ~/klipper && ~/mkdocs-env/bin/mkdocs serve --config-file ~/klipper/docs/_klipper3d/mkdocs.yml -a 0.0.0.0:8000 - -To test deploy the multi-language site locally one can use commands -similar to the following: - -virtualenv ~/mkdocs-env && ~/mkdocs-env/bin/pip install -r ~/klipper/docs/_klipper3d/mkdocs-requirements.txt -source ~/mkdocs-env/bin/activate -cd ~/klipper && ./docs/_klipper3d/build-translations.sh -cd ~/klipper/site/ && python3 -m http.server 8000 diff --git a/zh/_klipper3d/__pycache__/mkdocs_hooks.cpython-38.pyc b/zh/_klipper3d/__pycache__/mkdocs_hooks.cpython-38.pyc deleted file mode 100644 index 221e8754c..000000000 Binary files a/zh/_klipper3d/__pycache__/mkdocs_hooks.cpython-38.pyc and /dev/null differ diff --git a/zh/_klipper3d/build-translations.sh b/zh/_klipper3d/build-translations.sh deleted file mode 100644 index 4a0117c24..000000000 --- a/zh/_klipper3d/build-translations.sh +++ /dev/null @@ -1,84 +0,0 @@ -#!/bin/bash -# This script extracts the Klipper translations and builds multiple -# mdocs sites - one for each supported language. See the README file -# for additional details. - -MKDOCS_DIR="docs/_klipper3d/" -WORK_DIR="work/" -TRANS_DIR="${WORK_DIR}klipper-translations/" -TRANS_FILE="${TRANS_DIR}active_translations" -MKDOCS_MAIN="${MKDOCS_DIR}mkdocs-main.yml" - -# Fetch translations -git clone --depth 1 https://github.com/Klipper3d/klipper-translations ${TRANS_DIR} - -# Create new mkdocs-main.yml with language links -cp ${MKDOCS_DIR}mkdocs.yml ${MKDOCS_MAIN} -while IFS="," read dirname langsite langdesc langsearch; do - sed -i "s%^.*# Alternate language links automatically added here$% - name: ${langdesc}\n link: /${langsite}/\n lang: ${langsite}\n\0%" ${MKDOCS_MAIN} -done < <(egrep -v '^ *(#|$)' ${TRANS_FILE}) - -# Build main English website -echo "building site for en" -mkdocs build -f ${MKDOCS_MAIN} - -# Build each additional language website -while IFS="," read dirname langsite langdesc langsearch; do - new_docs_dir="${WORK_DIR}lang/${langsite}/docs/" - locale_dir="${TRANS_DIR}/docs/locales/${dirname}" - - # read toc - title=$(sed -n '1p' ${locale_dir}/Navigation.md) - installation_and_configuration=$(sed -n '3p' ${locale_dir}/Navigation.md) - configuration_reference=$(sed -n '5p' ${locale_dir}/Navigation.md) - bed_level=$(sed -n '7p' ${locale_dir}/Navigation.md) - resonance_compensation=$(sed -n '9p' ${locale_dir}/Navigation.md) - command_template=$(sed -n '11p' ${locale_dir}/Navigation.md) - developer_documentation=$(sed -n '13p' ${locale_dir}/Navigation.md) - device_specific_documents=$(sed -n '15p' ${locale_dir}/Navigation.md) - - # Copy markdown files to new_docs_dir - echo "Copying $dirname to $langsite" - mkdir -p "${new_docs_dir}" - cp "${locale_dir}"/*.md "${new_docs_dir}" - echo "copy resources" - cp -r docs/img "${new_docs_dir}" - cp -r docs/prints "${new_docs_dir}" - cp -r docs/_klipper3d "${new_docs_dir}" - - # manually replace index.md if a manual-index.md exist - manual_index="${new_docs_dir}manual-index.md" - if [[ -f "${manual_index}" ]]; then - mv -f "${manual_index}" "${new_docs_dir}index.md" - echo "replaced index.md with manual_index.md for $langsite" - else - echo "Manually translated index file for $langsite not found!" - fi - - # Create language specific mkdocs-lang-xxx.yml file - echo "create language specific mkdocs configurations for ${langsite}" - new_mkdocs_file="${new_docs_dir}_klipper3d/mkdocs-lang-${langsite}.yml" - cp "${MKDOCS_MAIN}" "${new_mkdocs_file}" - - echo "replace search language" - sed -i "s%^ lang: en$% lang: ${langsearch}%" "${new_mkdocs_file}" - - echo "replace site language" - sed -i "s%^ language: en$% language: ${langsite}%" "${new_mkdocs_file}" - - echo "replace toc" - sed -i "s%Klipper documentation$%${title}%" "${new_mkdocs_file}" - sed -i "s%Installation and Configuration:$%${installation_and_configuration}:%" "${new_mkdocs_file}" - sed -i "s%Configuration Reference:$%${configuration_reference}:%" "${new_mkdocs_file}" - sed -i "s%Bed Level:$%${bed_level}:%" "${new_mkdocs_file}" - sed -i "s%Resonance Compensation:$%${resonance_compensation}:%" "${new_mkdocs_file}" - sed -i "s%Command templates:$%${command_template}:%" "${new_mkdocs_file}" - sed -i "s%Developer Documentation:$%${developer_documentation}:%" "${new_mkdocs_file}" - sed -i "s%Device Specific Documents:$%${device_specific_documents}:%" "${new_mkdocs_file}" - - # Build site - echo "building site for ${langsite}" - mkdir -p "${PWD}/site/${langsite}/" - ln -sf "${PWD}/site/${langsite}/" "${WORK_DIR}lang/${langsite}/site" - mkdocs build -f "${new_mkdocs_file}" -done < <(egrep -v '^ *(#|$)' ${TRANS_FILE}) diff --git a/zh/_klipper3d/css/extra.css b/zh/_klipper3d/css/extra.css deleted file mode 100644 index ea57721b0..000000000 --- a/zh/_klipper3d/css/extra.css +++ /dev/null @@ -1,16 +0,0 @@ -/* Customization of mkdocs generated site */ -[data-md-color-scheme="slate"] { - --md-primary-fg-color: hsla(var(--md-hue),15%,12%,1); - --md-default-bg-color: hsla(var(--md-hue),17%,17%,1); - --md-typeset-a-color: steelblue; - --md-accent-fg-color: lightblue; -} - -img { - background-color: white; -} - -.center-image { - margin: 0 auto; - display: block; -} diff --git a/zh/_klipper3d/mkdocs-lang-zh.yml b/zh/_klipper3d/mkdocs-lang-zh.yml deleted file mode 100644 index 1fa5b21e5..000000000 --- a/zh/_klipper3d/mkdocs-lang-zh.yml +++ /dev/null @@ -1,160 +0,0 @@ -# Main configuration file for mkdocs generation of klipper3d.org website - -# Note that the build-translations.sh script expects a certain file -# layout. See that script and the README file for more details. - -# Site and directory configuration -site_name: Klipper 文档 -repo_url: https://github.com/Klipper3d/klipper -repo_name: Klipper3d/klipper -edit_uri: blob/master/docs/ -use_directory_urls: False -docs_dir: '../' -site_dir: '../../site/' - -# Custom markdown dialect settings -markdown_extensions: - - toc: - permalink: True - toc_depth: 6 - - attr_list - - mdx_partial_gfm - - mdx_truly_sane_lists - - mdx_breakless_lists -plugins: - search: - lang: ja - mkdocs-simple-hooks: - hooks: - on_page_markdown: "docs._klipper3d.mkdocs_hooks:transform" - exclude: - glob: "README.md" - -# Website layout configuration (using mkdocs-material theme) -theme: - name: material - palette: - - media: "(prefers-color-scheme: light)" - scheme: default - primary: white - accent: blue - toggle: - icon: material/lightbulb - name: Switch to dark mode - - media: "(prefers-color-scheme: dark)" - scheme: slate - primary: grey - accent: light blue - toggle: - icon: material/lightbulb-outline - name: Switch to light mode - logo: img/klipper.svg - favicon: img/favicon.ico - icon: - repo: fontawesome/brands/github - alternate: material/web - features: - #- navigation.tabs - #- navigation.expand - - navigation.top - # if enabled, the TOC doesn't work for some pages - # - toc.integrate - - search.suggest - - search.highlight - - search.share - language: zh -extra_css: - - _klipper3d/css/extra.css - -# Site usage statistics -extra: - # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#site-search-tracking - analytics: - provider: google - property: G-VEN1PGNQL4 - # Language Selection - alternate: - - name: English - link: / - lang: en - - name: 简体中文 - link: /zh/ - lang: zh - - name: 繁體中文 - link: /zh-Hant/ - lang: zh-Hant - - name: Magyar - link: /hu/ - lang: hu - - name: Italiano - link: /it/ - lang: it - - name: Français - link: /fr/ - lang: fr - # Alternate language links automatically added here - -# Navigation hierarchy (this should mimic the layout of Overview.md) -nav: - - Overview.md - - Features.md - - FAQ.md - - Releases.md - - Config_Changes.md - - Contact.md - - 安装和配置: - - Installation: - - Installation.md - - OctoPrint.md - - 配置参考: - - Config_Reference.md - - Rotation_Distance.md - - Config_checks.md - - 打印床调平: - - Bed_Level.md - - Delta_Calibrate.md - - Probe_Calibrate.md - - BLTouch.md - - Manual_Level.md - - Bed_Mesh.md - - Endstop_Phase.md - - Axis_Twist_Compensation.md - - 共振补偿: - - Resonance_Compensation.md - - Measuring_Resonances.md - - Pressure_Advance.md - - G-Codes.md - - 命令模板: - - Command_Templates.md - - Status_Reference.md - - TMC_Drivers.md - - Multi_MCU_Homing.md - - Slicers.md - - Skew_Correction.md - - Exclude_Object.md - - Using_PWM_Tools.md - - 开发者文档: - - Code_Overview.md - - Kinematics.md - - Protocol.md - - API_Server.md - - MCU_Commands.md - - CANBUS_protocol.md - - Debugging.md - - Benchmarks.md - - CONTRIBUTING.md - - Packaging.md - - 设备特定文档: - - Example_Configs.md - - SDCard_Updates.md - - RPi_microcontroller.md - - Beaglebone.md - - Bootloaders.md - - Bootloader_Entry.md - - CANBUS.md - - CANBUS_Troubleshooting.md - - TSL1401CL_Filament_Width_Sensor.md - - Hall_Filament_Width_Sensor.md - - Eddy_Probe.md - - Load_Cell.md - - Sponsors.md diff --git a/zh/_klipper3d/mkdocs-main.yml b/zh/_klipper3d/mkdocs-main.yml deleted file mode 100644 index 896865dd1..000000000 --- a/zh/_klipper3d/mkdocs-main.yml +++ /dev/null @@ -1,160 +0,0 @@ -# Main configuration file for mkdocs generation of klipper3d.org website - -# Note that the build-translations.sh script expects a certain file -# layout. See that script and the README file for more details. - -# Site and directory configuration -site_name: Klipper documentation -repo_url: https://github.com/Klipper3d/klipper -repo_name: Klipper3d/klipper -edit_uri: blob/master/docs/ -use_directory_urls: False -docs_dir: '../' -site_dir: '../../site/' - -# Custom markdown dialect settings -markdown_extensions: - - toc: - permalink: True - toc_depth: 6 - - attr_list - - mdx_partial_gfm - - mdx_truly_sane_lists - - mdx_breakless_lists -plugins: - search: - lang: en - mkdocs-simple-hooks: - hooks: - on_page_markdown: "docs._klipper3d.mkdocs_hooks:transform" - exclude: - glob: "README.md" - -# Website layout configuration (using mkdocs-material theme) -theme: - name: material - palette: - - media: "(prefers-color-scheme: light)" - scheme: default - primary: white - accent: blue - toggle: - icon: material/lightbulb - name: Switch to dark mode - - media: "(prefers-color-scheme: dark)" - scheme: slate - primary: grey - accent: light blue - toggle: - icon: material/lightbulb-outline - name: Switch to light mode - logo: img/klipper.svg - favicon: img/favicon.ico - icon: - repo: fontawesome/brands/github - alternate: material/web - features: - #- navigation.tabs - #- navigation.expand - - navigation.top - # if enabled, the TOC doesn't work for some pages - # - toc.integrate - - search.suggest - - search.highlight - - search.share - language: en -extra_css: - - _klipper3d/css/extra.css - -# Site usage statistics -extra: - # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#site-search-tracking - analytics: - provider: google - property: G-VEN1PGNQL4 - # Language Selection - alternate: - - name: English - link: / - lang: en - - name: 简体中文 - link: /zh/ - lang: zh - - name: 繁體中文 - link: /zh-Hant/ - lang: zh-Hant - - name: Magyar - link: /hu/ - lang: hu - - name: Italiano - link: /it/ - lang: it - - name: Français - link: /fr/ - lang: fr - # Alternate language links automatically added here - -# Navigation hierarchy (this should mimic the layout of Overview.md) -nav: - - Overview.md - - Features.md - - FAQ.md - - Releases.md - - Config_Changes.md - - Contact.md - - Installation and Configuration: - - Installation: - - Installation.md - - OctoPrint.md - - Configuration Reference: - - Config_Reference.md - - Rotation_Distance.md - - Config_checks.md - - Bed Level: - - Bed_Level.md - - Delta_Calibrate.md - - Probe_Calibrate.md - - BLTouch.md - - Manual_Level.md - - Bed_Mesh.md - - Endstop_Phase.md - - Axis_Twist_Compensation.md - - Resonance Compensation: - - Resonance_Compensation.md - - Measuring_Resonances.md - - Pressure_Advance.md - - G-Codes.md - - Command templates: - - Command_Templates.md - - Status_Reference.md - - TMC_Drivers.md - - Multi_MCU_Homing.md - - Slicers.md - - Skew_Correction.md - - Exclude_Object.md - - Using_PWM_Tools.md - - Developer Documentation: - - Code_Overview.md - - Kinematics.md - - Protocol.md - - API_Server.md - - MCU_Commands.md - - CANBUS_protocol.md - - Debugging.md - - Benchmarks.md - - CONTRIBUTING.md - - Packaging.md - - Device Specific Documents: - - Example_Configs.md - - SDCard_Updates.md - - RPi_microcontroller.md - - Beaglebone.md - - Bootloaders.md - - Bootloader_Entry.md - - CANBUS.md - - CANBUS_Troubleshooting.md - - TSL1401CL_Filament_Width_Sensor.md - - Hall_Filament_Width_Sensor.md - - Eddy_Probe.md - - Load_Cell.md - - Sponsors.md diff --git a/zh/_klipper3d/mkdocs-requirements.txt b/zh/_klipper3d/mkdocs-requirements.txt deleted file mode 100644 index 806ec0106..000000000 --- a/zh/_klipper3d/mkdocs-requirements.txt +++ /dev/null @@ -1,10 +0,0 @@ -# Python virtualenv module requirements for mkdocs -jinja2==3.1.6 -mkdocs==1.2.4 -mkdocs-material==8.1.3 -mkdocs-simple-hooks==0.1.3 -mkdocs-exclude==1.0.2 -mdx-truly-sane-lists==1.2 -mdx-breakless-lists==1.0.1 -py-gfm==1.0.2 -markdown==3.3.7 diff --git a/zh/_klipper3d/mkdocs.yml b/zh/_klipper3d/mkdocs.yml deleted file mode 100644 index e13fbe8de..000000000 --- a/zh/_klipper3d/mkdocs.yml +++ /dev/null @@ -1,145 +0,0 @@ -# Main configuration file for mkdocs generation of klipper3d.org website - -# Note that the build-translations.sh script expects a certain file -# layout. See that script and the README file for more details. - -# Site and directory configuration -site_name: Klipper documentation -repo_url: https://github.com/Klipper3d/klipper -repo_name: Klipper3d/klipper -edit_uri: blob/master/docs/ -use_directory_urls: False -docs_dir: '../' -site_dir: '../../site/' - -# Custom markdown dialect settings -markdown_extensions: - - toc: - permalink: True - toc_depth: 6 - - attr_list - - mdx_partial_gfm - - mdx_truly_sane_lists - - mdx_breakless_lists -plugins: - search: - lang: en - mkdocs-simple-hooks: - hooks: - on_page_markdown: "docs._klipper3d.mkdocs_hooks:transform" - exclude: - glob: "README.md" - -# Website layout configuration (using mkdocs-material theme) -theme: - name: material - palette: - - media: "(prefers-color-scheme: light)" - scheme: default - primary: white - accent: blue - toggle: - icon: material/lightbulb - name: Switch to dark mode - - media: "(prefers-color-scheme: dark)" - scheme: slate - primary: grey - accent: light blue - toggle: - icon: material/lightbulb-outline - name: Switch to light mode - logo: img/klipper.svg - favicon: img/favicon.ico - icon: - repo: fontawesome/brands/github - alternate: material/web - features: - #- navigation.tabs - #- navigation.expand - - navigation.top - # if enabled, the TOC doesn't work for some pages - # - toc.integrate - - search.suggest - - search.highlight - - search.share - language: en -extra_css: - - _klipper3d/css/extra.css - -# Site usage statistics -extra: - # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#site-search-tracking - analytics: - provider: google - property: G-VEN1PGNQL4 - # Language Selection - alternate: - - name: English - link: / - lang: en - # Alternate language links automatically added here - -# Navigation hierarchy (this should mimic the layout of Overview.md) -nav: - - Overview.md - - Features.md - - FAQ.md - - Releases.md - - Config_Changes.md - - Contact.md - - Installation and Configuration: - - Installation: - - Installation.md - - OctoPrint.md - - Configuration Reference: - - Config_Reference.md - - Rotation_Distance.md - - Config_checks.md - - Bed Level: - - Bed_Level.md - - Delta_Calibrate.md - - Probe_Calibrate.md - - BLTouch.md - - Manual_Level.md - - Bed_Mesh.md - - Endstop_Phase.md - - Axis_Twist_Compensation.md - - Resonance Compensation: - - Resonance_Compensation.md - - Measuring_Resonances.md - - Pressure_Advance.md - - G-Codes.md - - Command templates: - - Command_Templates.md - - Status_Reference.md - - TMC_Drivers.md - - Multi_MCU_Homing.md - - Slicers.md - - Skew_Correction.md - - Exclude_Object.md - - Using_PWM_Tools.md - - Developer Documentation: - - Code_Overview.md - - Kinematics.md - - Protocol.md - - API_Server.md - - MCU_Commands.md - - CANBUS_protocol.md - - Debugging.md - - Benchmarks.md - - CONTRIBUTING.md - - Packaging.md - - Device Specific Documents: - - Example_Configs.md - - SDCard_Updates.md - - RPi_microcontroller.md - - Beaglebone.md - - Bootloaders.md - - Bootloader_Entry.md - - CANBUS.md - - CANBUS_Troubleshooting.md - - TSL1401CL_Filament_Width_Sensor.md - - Hall_Filament_Width_Sensor.md - - Eddy_Probe.md - - Load_Cell.md - - Sponsors.md diff --git a/zh/_klipper3d/mkdocs_hooks.py b/zh/_klipper3d/mkdocs_hooks.py deleted file mode 100644 index 396832c44..000000000 --- a/zh/_klipper3d/mkdocs_hooks.py +++ /dev/null @@ -1,42 +0,0 @@ -# Tool to customize conversion of markdown files during mkdocs site generation -import re -import logging - -# This script translates some github specific markdown formatting to -# improve rendering with mkdocs. The goal is for pages to render -# similarly on both github and the web site. It has three main tasks: -# 1. Convert links outside of the docs directory (any reference -# starting with "../") to an absolute link to the raw file on -# github. -# 2. Convert a trailing backslash on a text line to a "
". -# 3. Remove leading spaces from top-level lists so that those lists -# are rendered correctly. - -logger = logging.getLogger('mkdocs.mkdocs_hooks.transform') - -def transform(markdown: str, page, config, files): - in_code_block = 0 - in_list = False - lines = markdown.splitlines() - for i in range(len(lines)): - line_out = lines[i] - in_code_block = (in_code_block + - len(re.findall("\s*[`]{3,}", line_out))) % 2 - if not in_code_block: - line_out = line_out.replace('](../', - f"]({config['repo_url']}blob/master/") - line_out = re.sub("\\\s*$", "
", line_out) - # check that lists at level 0 are not indented - # (no space before *|-|1.) - if re.match(r"^[^-*0-9 ]", line_out): - in_list = False - elif re.match(r"^(\*|-|\d+\.) ", line_out): - in_list = True - if not in_list: - line_out = re.sub(r"^\s+(\*|-|\d+\.) ", r"\1 ", line_out) - if line_out != lines[i]: - logger.debug((f'[mkdocs_hooks] rewrite line {i+1}: ' - f'"{lines[i]}" -> "{line_out}"')) - lines[i] = line_out - output = "\n".join(lines) - return output diff --git a/zh/sitemap.xml b/zh/sitemap.xml deleted file mode 100644 index 0809d3a19..000000000 --- a/zh/sitemap.xml +++ /dev/null @@ -1,283 +0,0 @@ - - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - - None - 2025-12-23 - daily - - \ No newline at end of file diff --git a/zh/sitemap.xml.gz b/zh/sitemap.xml.gz deleted file mode 100644 index 96279a636..000000000 Binary files a/zh/sitemap.xml.gz and /dev/null differ