summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJack Humbert <jack.humb@gmail.com>2018-12-02 15:35:53 -0500
committerGitHub <noreply@github.com>2018-12-02 15:35:53 -0500
commit5d47231f2a9353645aab07e14c1de21f00b7fc2f (patch)
tree8ab17221117fafe3003a25e269d559b64b9cd706
parentd5a06aec8386ef16e0751572c5182410b8d348f7 (diff)
Add sidebar for ZH (#4533)
* 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 * Delete README.md * add sidebar for zh
-rw-r--r--docs/zh-cn/README.md32
-rw-r--r--docs/zh/_sidebar.md99
2 files changed, 99 insertions, 32 deletions
diff --git a/docs/zh-cn/README.md b/docs/zh-cn/README.md
deleted file mode 100644
index bb9d1371f1..0000000000
--- a/docs/zh-cn/README.md
+++ /dev/null
@@ -1,32 +0,0 @@
-# QMK鍵盤固件
-
-[![當前版本](https://img.shields.io/github/tag/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/tags)
-[![築邦](https://travis-ci.org/qmk/qmk_firmware.svg?branch=master)](https://travis-ci.org/qmk/qmk_firmware)
-[![不和諧](https://img.shields.io/discord/440868230475677696.svg)](https://discord.gg/Uq7gcHh)
-[![文檔狀態](https://img.shields.io/badge/docs-ready-orange.svg)](https://docs.qmk.fm)
-[![GitHub的貢獻者](https://img.shields.io/github/contributors/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/pulse/monthly)
-[![GitHub的叉](https://img.shields.io/github/forks/qmk/qmk_firmware.svg?style=social&label=Fork)](https://github.com/qmk/qmk_firmware/)
-
-## 什麼是QMK固件?
-
-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發揮功能。
-
-## 如何得到QMK
-
-如果你打算貢獻鍵盤佈局,鍵盤或功能QMK,最容易做的事情是[叉通過Github上爬行](https://github.com/qmk/qmk_firmware#fork-destination-box),和克隆你爬在本地進行更改,推動他們,然後打開從你的叉子[拉請求](https://github.com/qmk/qmk_firmware/pulls)。
-
-否則,您可以直接下載([拉鍊](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`)。
-
-## 如何編譯
-
-你可以編譯之前,你需要[安裝環境](getting_started_build_tools.md)用於AVR或/和ARM開發。一旦完成,你會使用`make`命令建立一個鍵盤並用以下符號鍵盤佈局
-
- make planck/rev4:default
-
-這將建立`rev4` `planck`的修訂與`default`鍵盤映射。並非所有鍵盤有一個修訂版(也稱為子項目或文件夾),在這種情況下,它可以被省略:
-
- make preonic:default
-
-## 如何赶近
-
-QMK有很多[特點](features.md)探索和很好的協議[參考文獻](http://docs.qmk.fm)挖通的。大部分功能通過修改[鍵盤映射(keymap.md),並改變[鍵碼](keycodes.md)冤大頭。
diff --git a/docs/zh/_sidebar.md b/docs/zh/_sidebar.md
new file mode 100644
index 0000000000..c167612929
--- /dev/null
+++ b/docs/zh/_sidebar.md
@@ -0,0 +1,99 @@
+* [完全指南菜鳥](zh/newbs.md)
+ * [入門](zh/newbs_getting_started.md)
+ * [構建第一個固件](zh/newbs_building_firmware.md)
+ * [刷新固件](zh/newbs_flashing.md)
+ * [測試和調試](zh/newbs_testing_debugging.md)
+ * [最佳實踐](zh/newbs_best_practices.md)
+ * [學習資源](zh/newbs_learn_more_resources.md)
+
+* [QMK基礎](zh/README.md)
+ * [QMK簡介](zh/getting_started_introduction.md)
+ * [特約QMK](zh/contributing.md)
+ * [如何使用Github上](zh/getting_started_github.md)
+ * [獲得幫助](zh/getting_started_getting_help.md)
+
+* [常問問題](zh/faq.md)
+ * [常問問題](zh/faq_general.md)
+ * [構建/編譯QMK](zh/faq_build.md)
+ * [調試/故障排除QMK](zh/faq_debug.md)
+ * [鍵盤佈局](zh/faq_keymap.md)
+
+* 詳細指南
+ * [安裝編譯工具](zh/getting_started_build_tools.md)
+ * [流浪漢指南](zh/getting_started_vagrant.md)
+ * [構建/編譯器指令](zh/getting_started_make_guide.md)
+ * [刷新固件](zh/flashing.md)
+ * [定制功能](zh/custom_quantum_functions.md)
+ * [鍵盤映射概述](zh/keymap.md)
+
+* [硬件](zh/hardware.md)
+ * [AVR處理器](zh/hardware_avr.md)
+ * [司機](zh/hardware_drivers.md)
+
+* 參考
+ * [Keyboard Guidelines](zh/hardware_keyboard_guidelines.md)
+ * [Config Options](zh/config_options.md)
+ * [Keycodes](zh/keycodes.md)
+ * [Documentation Best Practices](zh/documentation_best_practices.md)
+ * [Documentation Templates](zh/documentation_templates.md)
+ * [Glossary](zh/reference_glossary.md)
+ * [Unit Testing](zh/unit_testing.md)
+ * [Useful Functions](zh/ref_functions.md)
+ * [Configurator Support](zh/reference_configurator_support.md)
+
+* [特點](zh/features.md)
+ * [Basic Keycodes](zh/keycodes_basic.md)
+ * [Quantum Keycodes](zh/quantum_keycodes.md)
+ * [Advanced Keycodes](zh/feature_advanced_keycodes.md)
+ * [Audio](zh/feature_audio.md)
+ * [Auto Shift](zh/feature_auto_shift.md)
+ * [Backlight](zh/feature_backlight.md)
+ * [Bluetooth](zh/feature_bluetooth.md)
+ * [Bootmagic](zh/feature_bootmagic.md)
+ * [Combos](zh/feature_combo)
+ * [Command](zh/feature_command.md)
+ * [Dynamic Macros](zh/feature_dynamic_macros.md)
+ * [Encoders](zh/feature_encoders.md)
+ * [Grave Escape](zh/feature_grave_esc.md)
+ * [Key Lock](zh/feature_key_lock.md)
+ * [Layouts](zh/feature_layouts.md)
+ * [Leader Key](zh/feature_leader_key.md)
+ * [Macros](zh/feature_macros.md)
+ * [Mouse Keys](zh/feature_mouse_keys.md)
+ * [One Shot Keys](zh/feature_advanced_keycodes.md#one-shot-keys)
+ * [Pointing Device](zh/feature_pointing_device.md)
+ * [PS/2 Mouse](zh/feature_ps2_mouse.md)
+ * [RGB Lighting](zh/feature_rgblight.md)
+ * [RGB Matrix](zh/feature_rgb_matrix.md)
+ * [Space Cadet Shift](zh/feature_space_cadet_shift.md)
+ * [Space Cadet Shift Enter](zh/feature_space_cadet_shift_enter.md)
+ * [Stenography](zh/feature_stenography.md)
+ * [Swap Hands](zh/feature_swap_hands.md)
+ * [Tap Dance](zh/feature_tap_dance.md)
+ * [Terminal](zh/feature_terminal.md)
+ * [Thermal Printer](zh/feature_thermal_printer.md)
+ * [Unicode](zh/feature_unicode.md)
+ * [Userspace](zh/feature_userspace.md)
+ * [US ANSI Shifted Keys](zh/keycodes_us_ansi_shifted.md)
+
+* 對於製造商和遊戲模組
+ * [Hand Wiring Guide](zh/hand_wire.md)
+ * [ISP Flashing Guide](zh/isp_flashing_guide.md)
+ * [ARM Debugging Guide](zh/arm_debugging.md)
+ * [I2C Driver](zh/i2c_driver.md)
+
+* 為了更深入的了解
+ * [How Keyboards Work](zh/how_keyboards_work.md)
+ * [Understanding QMK](zh/understanding_qmk.md)
+
+* 其它主題
+ * [Using Eclipse with QMK](zh/eclipse.md)
+
+* QMK內部(進行中)
+ * [Defines](zh/internals_defines.md)
+ * [Input Callback Reg](zh/internals_input_callback_reg.md)
+ * [Midi Device](zh/internals_midi_device.md)
+ * [Midi Device Setup Process](zh/internals_midi_device_setup_process.md)
+ * [Midi Util](zh/internals_midi_util.md)
+ * [Send Functions](zh/internals_send_functions.md)
+ * [Sysex Tools](zh/internals_sysex_tools.md)