From 68072e931a1e67ce2d6f71be5efff559305072d6 Mon Sep 17 00:00:00 2001 From: Jack Humbert Date: Tue, 1 Oct 2019 13:51:23 -0400 Subject: Expose zh-cn docs, delete bad zh docs, add docs for adding translations (#6855) * expose zh-cn docs, delete bad zh docs, add docs for adding translations * Update docs/translating.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update docs/translating.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * update for python 3 --- docs/translating.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 docs/translating.md (limited to 'docs/translating.md') diff --git a/docs/translating.md b/docs/translating.md new file mode 100644 index 0000000000..6eb268763a --- /dev/null +++ b/docs/translating.md @@ -0,0 +1,29 @@ +# How to translate the QMK docs into different languages + +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. + +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: + + * [QMK简介](zh-cn/getting_started_introduction.md) + +Once you've finished translating a new language, you'll also need to modify the following files: + +* [`docs/_langs.md`](https://github.com/qmk/qmk_firmware/blob/master/docs/_langs.md) + Each line should contain a country flag in the format `:us:` followed by the name represented in its own language: + + - [:cn: 中文](/zh-cn/) + +* [`docs/index.html`](https://github.com/qmk/qmk_firmware/blob/master/docs/index.html) + Both `placeholder` and `noData` objects should have a dictionary entry for the language folder in a string: + + '/zh-cn/': '没有结果!', + +## Previewing the translations + +Before opening a pull request, you can preview your additions if you have Python 3 installed by running this command in the `docs/` folder: + + python -m http.server 9000 + +and navigating to http://localhost:9000/ - you should be able to select your new language from the "Translations" menu at the top-right. + +Once you're happy with your work, feel free to open a pull request! -- cgit v1.2.3