diff options
Diffstat (limited to 'docs/_klipper3d')
| -rwxr-xr-x | docs/_klipper3d/fetch-translations.sh | 30 | ||||
| -rw-r--r-- | docs/_klipper3d/mkdocs-requirements.txt | 1 | ||||
| -rw-r--r-- | docs/_klipper3d/mkdocs.yml | 14 | ||||
| -rw-r--r-- | docs/_klipper3d/translations.yml | 5 |
4 files changed, 43 insertions, 7 deletions
diff --git a/docs/_klipper3d/fetch-translations.sh b/docs/_klipper3d/fetch-translations.sh new file mode 100755 index 00000000..79352f60 --- /dev/null +++ b/docs/_klipper3d/fetch-translations.sh @@ -0,0 +1,30 @@ +#!/bin/bash +# Modify the file structure before running mkdocs +# This is a make shift script before the current structure of +# Klipper-translations can be directly utilized by mkdocs +# Usage: pre-mkdocs.sh <lang_directory_name> <target_lang_name> + +#git clone --depth 1 https://github.com/Klipper3d/klipper-translations + +while IFS="," read dirname langname langdesc note; do + # move and rename markdown files + local_dir="klipper-translations/docs/locales/$dirname" + echo "Moving $dirname to $langname" + for file in "$local_dir"/*.md; do + mdfilename="${file/$local_dir\//}" + mv "$file" "./docs/${mdfilename//.md/.${langname}.md}" + done + + # manually replace index.md if a manual-index.md exist + manual_index="./docs/manual-index.$langname.md" + + if [[ -f "$manual_index" ]];then + mv "$manual_index" "./docs/index.${langname}.md" + echo "replaced index.${langname}.md with $manual_index" + else + echo "Manually translated index file for $dirname not found!" + fi + + # add to translations.yml + echo " ${langname}: ${langdesc}" >> ./docs/_klipper3d/translations.yml +done < <(egrep -v '^ *(#|$)' ./klipper-translations/active_translations | tail -n +2) diff --git a/docs/_klipper3d/mkdocs-requirements.txt b/docs/_klipper3d/mkdocs-requirements.txt index a7fcf1e9..425d583d 100644 --- a/docs/_klipper3d/mkdocs-requirements.txt +++ b/docs/_klipper3d/mkdocs-requirements.txt @@ -6,3 +6,4 @@ mkdocs-exclude==1.0.2 mdx-truly-sane-lists==1.2 mdx-breakless-lists==1.0.1 py-gfm==1.0.2 +mkdocs-static-i18n=0.30 diff --git a/docs/_klipper3d/mkdocs.yml b/docs/_klipper3d/mkdocs.yml index b2ebfcd1..a47ddbc8 100644 --- a/docs/_klipper3d/mkdocs.yml +++ b/docs/_klipper3d/mkdocs.yml @@ -8,6 +8,7 @@ edit_uri: blob/master/docs/ use_directory_urls: False docs_dir: '../' site_dir: '../../site/' +INHERIT: translations.yml # Markdown document translation settings markdown_extensions: @@ -19,13 +20,12 @@ markdown_extensions: - mdx_truly_sane_lists - mdx_breakless_lists plugins: - - search - - mkdocs-simple-hooks: - hooks: - on_page_markdown: "docs._klipper3d.mkdocs_hooks:transform" - - exclude: - glob: - - README.md + search: {} + mkdocs-simple-hooks: + hooks: + on_page_markdown: "docs._klipper3d.mkdocs_hooks:transform" + exclude: + glob: "README.md" # Website layout configuration (using mkdocs-material theme) theme: diff --git a/docs/_klipper3d/translations.yml b/docs/_klipper3d/translations.yml new file mode 100644 index 00000000..d70e3a78 --- /dev/null +++ b/docs/_klipper3d/translations.yml @@ -0,0 +1,5 @@ +plugins: + i18n: + default_language: en + languages: + en: English |