diff options
Diffstat (limited to 'docs/translating.md')
-rw-r--r-- | docs/translating.md | 44 |
1 files changed, 32 insertions, 12 deletions
diff --git a/docs/translating.md b/docs/translating.md index 6eb268763..12fe7c85f 100644 --- a/docs/translating.md +++ b/docs/translating.md | |||
@@ -1,29 +1,49 @@ | |||
1 | # How to translate the QMK docs into different languages | 1 | # Translating the QMK Docs |
2 | 2 | ||
3 | All files in the root folder (`docs/`) should be in English - all other languages should be in subfolders with the ISO 639-1 language codes, followed by `-` and the country code where relevant. [A list of common ones can be found here](https://www.andiamo.co.uk/resources/iso-language-codes/). If this folder doesn't exist, you may create it. Each of the translated files should have the same name as the English version, so things can fall back successfully. | 3 | All files in the root folder (`docs/`) should be in English - all other languages should be in subfolders with the ISO 639-1 language codes, followed by `-` and the country code where relevant. [A list of common ones can be found here](https://www.andiamo.co.uk/resources/iso-language-codes/). If this folder doesn't exist, you may create it. Each of the translated files should have the same name as the English version, so things can fall back successfully. |
4 | 4 | ||
5 | A `_summary.md` file should exist in this folder with a list of links to each file, with a translated name, and link preceded by the language folder: | 5 | A `_summary.md` file should exist in this folder with a list of links to each file, with a translated name, and link preceded by the language folder: |
6 | 6 | ||
7 | * [QMK简介](zh-cn/getting_started_introduction.md) | 7 | ```markdown |
8 | * [QMK简介](zh-cn/getting_started_introduction.md) | ||
9 | ``` | ||
10 | |||
11 | All links to other docs pages must also be prefixed with the language folder. If the link is to a specific part of the page (ie. a certain heading), you must use the English ID for the heading, like so: | ||
12 | |||
13 | ```markdown | ||
14 | [建立你的环境](zh-cn/newbs-getting-started.md#set-up-your-environment) | ||
15 | |||
16 | ## 建立你的环境 :id=set-up-your-environment | ||
17 | ``` | ||
8 | 18 | ||
9 | Once you've finished translating a new language, you'll also need to modify the following files: | 19 | Once you've finished translating a new language, you'll also need to modify the following files: |
10 | 20 | ||
11 | * [`docs/_langs.md`](https://github.com/qmk/qmk_firmware/blob/master/docs/_langs.md) | 21 | * [`docs/_langs.md`](https://github.com/qmk/qmk_firmware/blob/master/docs/_langs.md) |
12 | Each line should contain a country flag in the format `:us:` followed by the name represented in its own language: | 22 | Each line should contain a country flag as a [GitHub emoji shortcode](https://github.com/ikatyang/emoji-cheat-sheet/blob/master/README.md#country-flag) followed by the name represented in its own language: |
13 | 23 | ||
14 | - [:cn: 中文](/zh-cn/) | 24 | ```markdown |
25 | - [:cn: 中文](/zh-cn/) | ||
26 | ``` | ||
15 | 27 | ||
16 | * [`docs/index.html`](https://github.com/qmk/qmk_firmware/blob/master/docs/index.html) | 28 | * [`docs/index.html`](https://github.com/qmk/qmk_firmware/blob/master/docs/index.html) |
17 | Both `placeholder` and `noData` objects should have a dictionary entry for the language folder in a string: | 29 | Both `placeholder` and `noData` objects should have a dictionary entry for the language folder in a string: |
18 | 30 | ||
19 | '/zh-cn/': '没有结果!', | 31 | ```js |
32 | '/zh-cn/': '没有结果!', | ||
33 | ``` | ||
20 | 34 | ||
21 | ## Previewing the translations | 35 | And make sure to add the language folder in the `fallbackLanguages` list, so it will properly fall back to English instead of 404ing: |
22 | 36 | ||
23 | Before opening a pull request, you can preview your additions if you have Python 3 installed by running this command in the `docs/` folder: | 37 | ```js |
38 | fallbackLanguages: [ | ||
39 | // ... | ||
40 | 'zh-cn', | ||
41 | // ... | ||
42 | ], | ||
43 | ``` | ||
24 | 44 | ||
25 | python -m http.server 9000 | 45 | ## Previewing the Translations |
26 | 46 | ||
27 | and navigating to http://localhost:9000/ - you should be able to select your new language from the "Translations" menu at the top-right. | 47 | See (Previewing the Documentation)[contributing.md#previewing-the-documentation] for how to set up a local instance of the docs - you should be able to select your new language from the "Translations" menu at the top-right. |
28 | 48 | ||
29 | Once you're happy with your work, feel free to open a pull request! | 49 | Once you're happy with your work, feel free to open a pull request! |