diff options
author | Jack Humbert <jack.humb@gmail.com> | 2018-12-02 15:12:54 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-12-02 15:12:54 -0500 |
commit | d5a06aec8386ef16e0751572c5182410b8d348f7 (patch) | |
tree | 9bbb171a55d23a5b1bb09b6800566563087a2eb9 | |
parent | dbc776168842439718334aa120f1afcbee9a96d9 (diff) | |
download | qmk_firmware-d5a06aec8386ef16e0751572c5182410b8d348f7.tar.gz qmk_firmware-d5a06aec8386ef16e0751572c5182410b8d348f7.zip |
Second try at configuring i18n for docsify and gitbook (#4531)
* add zh-cn readme
* edit readme
* Round 1 of edits
- Mandarin translation of QMK products is off, best to use the English name.
- Fix some terminology and grammar.
* trying re-translating the first paragraph
* add fallback langurages
* Create LANGS.md
* Rename docs/zh-cn/README.md to docs/zh/README.md
* Update LANGS.md
* Update index.html
-rw-r--r-- | docs/LANGS.md | 4 | ||||
-rw-r--r-- | docs/index.html | 3 | ||||
-rw-r--r-- | docs/zh/README.md | 32 |
3 files changed, 38 insertions, 1 deletions
diff --git a/docs/LANGS.md b/docs/LANGS.md new file mode 100644 index 000000000..4b48f2d3d --- /dev/null +++ b/docs/LANGS.md | |||
@@ -0,0 +1,4 @@ | |||
1 | # Languages | ||
2 | |||
3 | * [English](/) | ||
4 | * [Chinese](zh/) | ||
diff --git a/docs/index.html b/docs/index.html index f0b1fae07..f5aa92b53 100644 --- a/docs/index.html +++ b/docs/index.html | |||
@@ -25,7 +25,8 @@ | |||
25 | placeholder: 'Search Documentation...', | 25 | placeholder: 'Search Documentation...', |
26 | noData: 'We could not find any documents matching your search.', | 26 | noData: 'We could not find any documents matching your search.', |
27 | depth: 6 | 27 | depth: 6 |
28 | } | 28 | }, |
29 | fallbackLanguages: ['zh'] | ||
29 | } | 30 | } |
30 | </script> | 31 | </script> |
31 | <script src="//unpkg.com/docsify/lib/docsify.min.js"></script> | 32 | <script src="//unpkg.com/docsify/lib/docsify.min.js"></script> |
diff --git a/docs/zh/README.md b/docs/zh/README.md new file mode 100644 index 000000000..bb9d1371f --- /dev/null +++ b/docs/zh/README.md | |||
@@ -0,0 +1,32 @@ | |||
1 | # QMK鍵盤固件 | ||
2 | |||
3 | [](https://github.com/qmk/qmk_firmware/tags) | ||
4 | [](https://travis-ci.org/qmk/qmk_firmware) | ||
5 | [](https://discord.gg/Uq7gcHh) | ||
6 | [](https://docs.qmk.fm) | ||
7 | [](https://github.com/qmk/qmk_firmware/pulse/monthly) | ||
8 | [](https://github.com/qmk/qmk_firmware/) | ||
9 | |||
10 | ## 什麼是QMK固件? | ||
11 | |||
12 | QMK是一個由社群維護的開源鍵盤韌體,其中包含了QMK Toolbox、qmk.fm和其它文件。QMK韌體是以[tmk\_keyboard](http://github.com/tmk/tmk_keyboard)為基礎,讓一些有用的功能在Atmel AVR控制器實現,使用於[OLKB](https://olkb.com)、[ergodox EZ](http://www.ergodox-ez.com),和[Clueboard](http://clueboard.co/)的產品中。它也被移植到使用ChibiOS的ARM晶片上。你也可以用它來讓你徒手佈線,或是客製的鍵盤PCB發揮功能。 | ||
13 | |||
14 | ## 如何得到QMK | ||
15 | |||
16 | 如果你打算貢獻鍵盤佈局,鍵盤或功能QMK,最容易做的事情是[叉通過Github上爬行](https://github.com/qmk/qmk_firmware#fork-destination-box),和克隆你爬在本地進行更改,推動他們,然後打開從你的叉子[拉請求](https://github.com/qmk/qmk_firmware/pulls)。 | ||
17 | |||
18 | 否則,您可以直接下載([拉鍊](https://github.com/qmk/qmk_firmware/zipball/master) [焦油](https://github.com/qmk/qmk_firmware/tarball/master)),或者通過GIT中克隆它(`git@github.com:qmk/qmk_firmware.git`)或HTTP(`https://github.com/qmk/qmk_firmware.git`)。 | ||
19 | |||
20 | ## 如何編譯 | ||
21 | |||
22 | 你可以編譯之前,你需要[安裝環境](getting_started_build_tools.md)用於AVR或/和ARM開發。一旦完成,你會使用`make`命令建立一個鍵盤並用以下符號鍵盤佈局 | ||
23 | |||
24 | make planck/rev4:default | ||
25 | |||
26 | 這將建立`rev4` `planck`的修訂與`default`鍵盤映射。並非所有鍵盤有一個修訂版(也稱為子項目或文件夾),在這種情況下,它可以被省略: | ||
27 | |||
28 | make preonic:default | ||
29 | |||
30 | ## 如何赶近 | ||
31 | |||
32 | QMK有很多[特點](features.md)探索和很好的協議[參考文獻](http://docs.qmk.fm)挖通的。大部分功能通過修改[鍵盤映射(keymap.md),並改變[鍵碼](keycodes.md)冤大頭。 | ||