diff options
-rw-r--r-- | docs/LANGS.md | 4 | ||||
-rw-r--r-- | docs/_langs.md | 3 | ||||
-rw-r--r-- | docs/_summary.md | 1 | ||||
-rw-r--r-- | docs/index.html | 40 | ||||
-rw-r--r-- | docs/translating.md | 29 | ||||
-rw-r--r-- | docs/zh-cn/_summary.md | 181 | ||||
-rw-r--r-- | docs/zh/README.md | 32 | ||||
-rw-r--r-- | docs/zh/_summary.md | 99 |
8 files changed, 159 insertions, 230 deletions
diff --git a/docs/LANGS.md b/docs/LANGS.md deleted file mode 100644 index 4b48f2d3d..000000000 --- a/docs/LANGS.md +++ /dev/null | |||
@@ -1,4 +0,0 @@ | |||
1 | # Languages | ||
2 | |||
3 | * [English](/) | ||
4 | * [Chinese](zh/) | ||
diff --git a/docs/_langs.md b/docs/_langs.md new file mode 100644 index 000000000..382231d50 --- /dev/null +++ b/docs/_langs.md | |||
@@ -0,0 +1,3 @@ | |||
1 | - Translations | ||
2 | - [:uk: English](/) | ||
3 | - [:cn: 中文](/zh-cn/) \ No newline at end of file | ||
diff --git a/docs/_summary.md b/docs/_summary.md index 233b2cdaa..65bfa11f0 100644 --- a/docs/_summary.md +++ b/docs/_summary.md | |||
@@ -109,6 +109,7 @@ | |||
109 | * [Using Eclipse with QMK](other_eclipse.md) | 109 | * [Using Eclipse with QMK](other_eclipse.md) |
110 | * [Using VSCode with QMK](other_vscode.md) | 110 | * [Using VSCode with QMK](other_vscode.md) |
111 | * [Support](support.md) | 111 | * [Support](support.md) |
112 | * [How to add translations](translating.md) | ||
112 | 113 | ||
113 | * QMK Internals (In Progress) | 114 | * QMK Internals (In Progress) |
114 | * [Defines](internals_defines.md) | 115 | * [Defines](internals_defines.md) |
diff --git a/docs/index.html b/docs/index.html index d4016e27d..94372944a 100644 --- a/docs/index.html +++ b/docs/index.html | |||
@@ -3,6 +3,7 @@ | |||
3 | <head> | 3 | <head> |
4 | <meta charset="UTF-8"> | 4 | <meta charset="UTF-8"> |
5 | <title>QMK Firmware</title> | 5 | <title>QMK Firmware</title> |
6 | <link rel="icon" type="image/png" href="gitbook/images/favicon.png"> | ||
6 | <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" /> | 7 | <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" /> |
7 | <meta name="description" content="Description"> | 8 | <meta name="description" content="Description"> |
8 | <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0"> | 9 | <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0"> |
@@ -20,19 +21,50 @@ | |||
20 | <div id="app"></div> | 21 | <div id="app"></div> |
21 | <script> | 22 | <script> |
22 | window.$docsify = { | 23 | window.$docsify = { |
24 | alias : { | ||
25 | '/en/(.*)': '/$1', | ||
26 | '/en-us/(.*)': '/$1', | ||
27 | '/en-gb/(.*)': '/$1', | ||
28 | '/.*/_langs.md': '/_langs.md', | ||
29 | }, | ||
30 | basePath: '/', | ||
23 | name: 'QMK Firmware', | 31 | name: 'QMK Firmware', |
24 | nameLink: 'https://qmk.fm/', | 32 | nameLink: '/', |
25 | repo: 'qmk/qmk_firmware', | 33 | repo: 'qmk/qmk_firmware', |
26 | loadSidebar: '_summary.md', | 34 | loadSidebar: '_summary.md', |
35 | loadNavbar: '_langs.md', | ||
36 | mergeNavbar: true, | ||
27 | auto2top: true, | 37 | auto2top: true, |
28 | formatUpdated: '{YYYY}/{MM}/{DD} {HH}:{mm}', | 38 | formatUpdated: '{YYYY}/{MM}/{DD} {HH}:{mm}', |
29 | search: { | 39 | search: { |
30 | paths: 'auto', | 40 | paths: 'auto', |
31 | placeholder: 'Search Documentation...', | 41 | placeholder: { |
32 | noData: 'We could not find any documents matching your search.', | 42 | '/zh-cn/': '搜索', |
43 | '/': 'Search' | ||
44 | }, | ||
45 | noData: { | ||
46 | '/zh-cn/': '没有结果!', | ||
47 | '/': 'No results!' | ||
48 | }, | ||
33 | depth: 6 | 49 | depth: 6 |
34 | }, | 50 | }, |
35 | fallbackLanguages: ['zh'] | 51 | plugins: [ |
52 | function (hook, vm) { | ||
53 | hook.beforeEach(function (html) { | ||
54 | if (/githubusercontent\.com/.test(vm.route.file)) { | ||
55 | url = vm.route.file | ||
56 | .replace('raw.githubusercontent.com', 'github.com') | ||
57 | .replace(/\/master/, '/blob/master') | ||
58 | } else { | ||
59 | url = 'https://github.com/qmk/qmk_firmware/blob/master/docs/' + vm.route.file | ||
60 | } | ||
61 | var editHtml = '[:memo: Edit Document](' + url + ')\n' | ||
62 | return html | ||
63 | + '\n\n----\n\n' | ||
64 | + editHtml | ||
65 | }) | ||
66 | }, | ||
67 | ] | ||
36 | } | 68 | } |
37 | </script> | 69 | </script> |
38 | <script src="//unpkg.com/docsify/lib/docsify.min.js"></script> | 70 | <script src="//unpkg.com/docsify/lib/docsify.min.js"></script> |
diff --git a/docs/translating.md b/docs/translating.md new file mode 100644 index 000000000..6eb268763 --- /dev/null +++ b/docs/translating.md | |||
@@ -0,0 +1,29 @@ | |||
1 | # How to translate the QMK docs into different languages | ||
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. | ||
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: | ||
6 | |||
7 | * [QMK简介](zh-cn/getting_started_introduction.md) | ||
8 | |||
9 | Once you've finished translating a new language, you'll also need to modify the following files: | ||
10 | |||
11 | * [`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: | ||
13 | |||
14 | - [:cn: 中文](/zh-cn/) | ||
15 | |||
16 | * [`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: | ||
18 | |||
19 | '/zh-cn/': '没有结果!', | ||
20 | |||
21 | ## Previewing the translations | ||
22 | |||
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: | ||
24 | |||
25 | python -m http.server 9000 | ||
26 | |||
27 | and navigating to http://localhost:9000/ - you should be able to select your new language from the "Translations" menu at the top-right. | ||
28 | |||
29 | Once you're happy with your work, feel free to open a pull request! | ||
diff --git a/docs/zh-cn/_summary.md b/docs/zh-cn/_summary.md index 98b1440d9..033fecde4 100644 --- a/docs/zh-cn/_summary.md +++ b/docs/zh-cn/_summary.md | |||
@@ -1,107 +1,106 @@ | |||
1 | * [完全菜鸟指南](newbs.md) | 1 | * [完全菜鸟指南](zh-cn/newbs.md) |
2 | * [入门](newbs_getting_started.md) | 2 | * [入门](zh-cn/newbs_getting_started.md) |
3 | * [构建你的第一个固件](newbs_building_firmware.md) | 3 | * [构建你的第一个固件](zh-cn/newbs_building_firmware.md) |
4 | * [刷新固件](newbs_flashing.md) | 4 | * [刷新固件](zh-cn/newbs_flashing.md) |
5 | * [测试和调试](newbs_testing_debugging.md) | 5 | * [测试和调试](zh-cn/newbs_testing_debugging.md) |
6 | * [Git最佳实践](newbs_best_practices.md) | 6 | * [Git最佳实践](zh-cn/newbs_best_practices.md) |
7 | * [学习资源](newbs_learn_more_resources.md) | 7 | * [学习资源](zh-cn/newbs_learn_more_resources.md) |
8 | 8 | ||
9 | * [QMK基础](README.md) | 9 | * [QMK基础](zh-cn/README.md) |
10 | * [QMK简介](getting_started_introduction.md) | 10 | * [QMK简介](zh-cn/getting_started_introduction.md) |
11 | * [向QMK贡献](contributing.md) | 11 | * [向QMK贡献](zh-cn/contributing.md) |
12 | * [如何使用Github](getting_started_github.md) | 12 | * [如何使用Github](zh-cn/getting_started_github.md) |
13 | * [获得帮助](getting_started_getting_help.md) | 13 | * [获得帮助](zh-cn/getting_started_getting_help.md) |
14 | 14 | ||
15 | * [问题解答](faq.md) | 15 | * [问题解答](zh-cn/faq.md) |
16 | * [一般问题](faq_general.md) | 16 | * [一般问题](zh-cn/faq_general.md) |
17 | * [构建/编译](faq_build.md) | 17 | * [构建/编译](zh-cn/faq_build.md) |
18 | * [调试/故障排除](faq_debug.md) | 18 | * [调试/故障排除](zh-cn/faq_debug.md) |
19 | * [键盘映射](faq_keymap.md) | 19 | * [键盘映射](zh-cn/faq_keymap.md) |
20 | 20 | ||
21 | * 详细指南 | 21 | * 详细指南 |
22 | * [安装构建工具](getting_started_build_tools.md) | 22 | * [安装构建工具](zh-cn/getting_started_build_tools.md) |
23 | * [vagrant指南](getting_started_vagrant.md) | 23 | * [vagrant指南](zh-cn/getting_started_vagrant.md) |
24 | * [构建/编译指令](getting_started_make_guide.md) | 24 | * [构建/编译指令](zh-cn/getting_started_make_guide.md) |
25 | * [刷新固件](flashing.md) | 25 | * [刷新固件](zh-cn/flashing.md) |
26 | * [定制功能](custom_quantum_functions.md) | 26 | * [定制功能](zh-cn/custom_quantum_functions.md) |
27 | * [映射概述](keymap.md) | 27 | * [映射概述](zh-cn/keymap.md) |
28 | 28 | ||
29 | * [硬件](hardware.md) | 29 | * [硬件](zh-cn/hardware.md) |
30 | * [AVR处理器](hardware_avr.md) | 30 | * [AVR处理器](zh-cn/hardware_avr.md) |
31 | * [驱动](hardware_drivers.md) | 31 | * [驱动](zh-cn/hardware_drivers.md) |
32 | 32 | ||
33 | * 参考 | 33 | * 参考 |
34 | * [键盘指南](hardware_keyboard_guidelines.md) | 34 | * [键盘指南](zh-cn/hardware_keyboard_guidelines.md) |
35 | * [配置选项](config_options.md) | 35 | * [配置选项](zh-cn/config_options.md) |
36 | * [键码](keycodes.md) | 36 | * [键码](zh-cn/keycodes.md) |
37 | * [记录最佳实践](documentation_best_practices.md) | 37 | * [记录最佳实践](zh-cn/documentation_best_practices.md) |
38 | * [文档模板](documentation_templates.md) | 38 | * [文档模板](zh-cn/documentation_templates.md) |
39 | * [术语表](reference_glossary.md) | 39 | * [术语表](zh-cn/reference_glossary.md) |
40 | * [单元测试](unit_testing.md) | 40 | * [单元测试](zh-cn/unit_testing.md) |
41 | * [有用的功能](ref_functions.md) | 41 | * [有用的功能](zh-cn/ref_functions.md) |
42 | * [配置器支持](reference_configurator_support.md) | 42 | * [配置器支持](zh-cn/reference_configurator_support.md) |
43 | * [info.json 格式](reference_info_json.md) | 43 | * [info.json 格式](zh-cn/reference_info_json.md) |
44 | 44 | ||
45 | * [特性](features.md) | 45 | * [特性](zh-cn/features.md) |
46 | * [基本键码](keycodes_basic.md) | 46 | * [基本键码](zh-cn/keycodes_basic.md) |
47 | * [US ANSI控制码](keycodes_us_ansi_shifted.md) | 47 | * [US ANSI控制码](zh-cn/keycodes_us_ansi_shifted.md) |
48 | * [量子键码](quantum_keycodes.md) | 48 | * [量子键码](zh-cn/quantum_keycodes.md) |
49 | * [高级键码](feature_advanced_keycodes.md) | 49 | * [高级键码](zh-cn/feature_advanced_keycodes.md) |
50 | * [音频](feature_audio.md) | 50 | * [音频](zh-cn/feature_audio.md) |
51 | * [自动shift](feature_auto_shift.md) | 51 | * [自动shift](zh-cn/feature_auto_shift.md) |
52 | * [背光](feature_backlight.md) | 52 | * [背光](zh-cn/feature_backlight.md) |
53 | * [蓝牙](feature_bluetooth.md) | 53 | * [蓝牙](zh-cn/feature_bluetooth.md) |
54 | * [热改键](feature_bootmagic.md) | 54 | * [热改键](zh-cn/feature_bootmagic.md) |
55 | * [组合](feature_combo) | 55 | * [组合](zh-cn/feature_combo) |
56 | * [命令](feature_command.md) | 56 | * [命令](zh-cn/feature_command.md) |
57 | * [拨动开关](feature_dip_switch.md) | 57 | * [拨动开关](zh-cn/feature_dip_switch.md) |
58 | * [动态宏指令](feature_dynamic_macros.md) | 58 | * [动态宏指令](zh-cn/feature_dynamic_macros.md) |
59 | * [编码器](feature_encoders.md) | 59 | * [编码器](zh-cn/feature_encoders.md) |
60 | * [重音号Esc复合键](feature_grave_esc.md) | 60 | * [重音号Esc复合键](zh-cn/feature_grave_esc.md) |
61 | * [自锁键](feature_key_lock.md) | 61 | * [自锁键](zh-cn/feature_key_lock.md) |
62 | * [布局](feature_layouts.md) | 62 | * [布局](zh-cn/feature_layouts.md) |
63 | * [前导键](feature_leader_key.md) | 63 | * [前导键](zh-cn/feature_leader_key.md) |
64 | * [LED阵列](feature_led_matrix.md) | 64 | * [LED阵列](zh-cn/feature_led_matrix.md) |
65 | * [宏指令](feature_macros.md) | 65 | * [宏指令](zh-cn/feature_macros.md) |
66 | * [鼠标键](feature_mouse_keys.md) | 66 | * [鼠标键](zh-cn/feature_mouse_keys.md) |
67 | * [一键功能](feature_advanced_keycodes.md#one-shot-keys) | 67 | * [一键功能](zh-cn/feature_advanced_keycodes.md#one-shot-keys) |
68 | * [指针设备](feature_pointing_device.md) | 68 | * [指针设备](zh-cn/feature_pointing_device.md) |
69 | * [PS/2鼠标](feature_ps2_mouse.md) | 69 | * [PS/2鼠标](zh-cn/feature_ps2_mouse.md) |
70 | * [RGB灯光](feature_rgblight.md) | 70 | * [RGB灯光](zh-cn/feature_rgblight.md) |
71 | * [RGB矩阵](feature_rgb_matrix.md) | 71 | * [RGB矩阵](zh-cn/feature_rgb_matrix.md) |
72 | * [空格候补换挡](feature_space_cadet_shift.md) | 72 | * [空格候补换挡](zh-cn/feature_space_cadet.md) |
73 | * [空格候补换挡回车](feature_space_cadet_shift_enter.md) | 73 | * [速录机](zh-cn/feature_stenography.md) |
74 | * [速录机](feature_stenography.md) | 74 | * [换手](zh-cn/feature_swap_hands.md) |
75 | * [换手](feature_swap_hands.md) | 75 | * [多击键](zh-cn/feature_tap_dance.md) |
76 | * [多击键](feature_tap_dance.md) | 76 | * [终端](zh-cn/feature_terminal.md) |
77 | * [终端](feature_terminal.md) | 77 | * [热敏打印机](zh-cn/feature_thermal_printer.md) |
78 | * [热敏打印机](feature_thermal_printer.md) | 78 | * [Unicode](zh-cn/feature_unicode.md) |
79 | * [Unicode](feature_unicode.md) | 79 | * [用户空间](zh-cn/feature_userspace.md) |
80 | * [用户空间](feature_userspace.md) | 80 | * [速度键](zh-cn/feature_velocikey.md) |
81 | * [速度键](feature_velocikey.md) | ||
82 | 81 | ||
83 | * 针对制造者和定制者 | 82 | * 针对制造者和定制者 |
84 | * [手工连线指南](hand_wire.md) | 83 | * [手工连线指南](zh-cn/hand_wire.md) |
85 | * [ISP刷新指南](isp_flashing_guide.md) | 84 | * [ISP刷新指南](zh-cn/isp_flashing_guide.md) |
86 | * [ARM调试指南](arm_debugging.md) | 85 | * [ARM调试指南](zh-cn/arm_debugging.md) |
87 | * [I2C驱动](i2c_driver.md) | 86 | * [I2C驱动](zh-cn/i2c_driver.md) |
88 | * [GPIO控制器](internals_gpio_control.md) | 87 | * [GPIO控制器](zh-cn/internals_gpio_control.md) |
89 | * [Proton C转换](proton_c_conversion.md) | 88 | * [Proton C转换](zh-cn/proton_c_conversion.md) |
90 | 89 | ||
91 | * 深入了解 | 90 | * 深入了解 |
92 | * [键盘如何工作](how_keyboards_work.md) | 91 | * [键盘如何工作](zh-cn/how_keyboards_work.md) |
93 | * [理解QMK](understanding_qmk.md) | 92 | * [理解QMK](zh-cn/understanding_qmk.md) |
94 | 93 | ||
95 | * 其他话题 | 94 | * 其他话题 |
96 | * [使用Eclipse开发QMK](other_eclipse.md) | 95 | * [使用Eclipse开发QMK](zh-cn/other_eclipse.md) |
97 | * [使用VSCode开发QMK](other_vscode.md) | 96 | * [使用VSCode开发QMK](zh-cn/other_vscode.md) |
98 | * [支持](support.md) | 97 | * [支持](zh-cn/support.md) |
99 | 98 | ||
100 | * QMK 内构 (正在编写) | 99 | * QMK 内构 (正在编写) |
101 | * [定义](internals_defines.md) | 100 | * [定义](zh-cn/internals_defines.md) |
102 | * [输入回调寄存器](internals_input_callback_reg.md) | 101 | * [输入回调寄存器](zh-cn/internals_input_callback_reg.md) |
103 | * [Midi设备](internals_midi_device.md) | 102 | * [Midi设备](zh-cn/internals_midi_device.md) |
104 | * [Midi设备设置过程](internals_midi_device_setup_process.md) | 103 | * [Midi设备设置过程](zh-cn/internals_midi_device_setup_process.md) |
105 | * [Midi工具库](internals_midi_util.md) | 104 | * [Midi工具库](zh-cn/internals_midi_util.md) |
106 | * [发送函数](internals_send_functions.md) | 105 | * [发送函数](zh-cn/internals_send_functions.md) |
107 | * [Sysex工具](internals_sysex_tools.md) | 106 | * [Sysex工具](zh-cn/internals_sysex_tools.md) |
diff --git a/docs/zh/README.md b/docs/zh/README.md deleted file mode 100644 index bb9d1371f..000000000 --- a/docs/zh/README.md +++ /dev/null | |||
@@ -1,32 +0,0 @@ | |||
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)冤大頭。 | ||
diff --git a/docs/zh/_summary.md b/docs/zh/_summary.md deleted file mode 100644 index c16761292..000000000 --- a/docs/zh/_summary.md +++ /dev/null | |||
@@ -1,99 +0,0 @@ | |||
1 | * [完全指南菜鳥](zh/newbs.md) | ||
2 | * [入門](zh/newbs_getting_started.md) | ||
3 | * [構建第一個固件](zh/newbs_building_firmware.md) | ||
4 | * [刷新固件](zh/newbs_flashing.md) | ||
5 | * [測試和調試](zh/newbs_testing_debugging.md) | ||
6 | * [最佳實踐](zh/newbs_best_practices.md) | ||
7 | * [學習資源](zh/newbs_learn_more_resources.md) | ||
8 | |||
9 | * [QMK基礎](zh/README.md) | ||
10 | * [QMK簡介](zh/getting_started_introduction.md) | ||
11 | * [特約QMK](zh/contributing.md) | ||
12 | * [如何使用Github上](zh/getting_started_github.md) | ||
13 | * [獲得幫助](zh/getting_started_getting_help.md) | ||
14 | |||
15 | * [常問問題](zh/faq.md) | ||
16 | * [常問問題](zh/faq_general.md) | ||
17 | * [構建/編譯QMK](zh/faq_build.md) | ||
18 | * [調試/故障排除QMK](zh/faq_debug.md) | ||
19 | * [鍵盤佈局](zh/faq_keymap.md) | ||
20 | |||
21 | * 詳細指南 | ||
22 | * [安裝編譯工具](zh/getting_started_build_tools.md) | ||
23 | * [流浪漢指南](zh/getting_started_vagrant.md) | ||
24 | * [構建/編譯器指令](zh/getting_started_make_guide.md) | ||
25 | * [刷新固件](zh/flashing.md) | ||
26 | * [定制功能](zh/custom_quantum_functions.md) | ||
27 | * [鍵盤映射概述](zh/keymap.md) | ||
28 | |||
29 | * [硬件](zh/hardware.md) | ||
30 | * [AVR處理器](zh/hardware_avr.md) | ||
31 | * [司機](zh/hardware_drivers.md) | ||
32 | |||
33 | * 參考 | ||
34 | * [Keyboard Guidelines](zh/hardware_keyboard_guidelines.md) | ||
35 | * [Config Options](zh/config_options.md) | ||
36 | * [Keycodes](zh/keycodes.md) | ||
37 | * [Documentation Best Practices](zh/documentation_best_practices.md) | ||
38 | * [Documentation Templates](zh/documentation_templates.md) | ||
39 | * [Glossary](zh/reference_glossary.md) | ||
40 | * [Unit Testing](zh/unit_testing.md) | ||
41 | * [Useful Functions](zh/ref_functions.md) | ||
42 | * [Configurator Support](zh/reference_configurator_support.md) | ||
43 | |||
44 | * [特點](zh/features.md) | ||
45 | * [Basic Keycodes](zh/keycodes_basic.md) | ||
46 | * [Quantum Keycodes](zh/quantum_keycodes.md) | ||
47 | * [Advanced Keycodes](zh/feature_advanced_keycodes.md) | ||
48 | * [Audio](zh/feature_audio.md) | ||
49 | * [Auto Shift](zh/feature_auto_shift.md) | ||
50 | * [Backlight](zh/feature_backlight.md) | ||
51 | * [Bluetooth](zh/feature_bluetooth.md) | ||
52 | * [Bootmagic](zh/feature_bootmagic.md) | ||
53 | * [Combos](zh/feature_combo) | ||
54 | * [Command](zh/feature_command.md) | ||
55 | * [Dynamic Macros](zh/feature_dynamic_macros.md) | ||
56 | * [Encoders](zh/feature_encoders.md) | ||
57 | * [Grave Escape](zh/feature_grave_esc.md) | ||
58 | * [Key Lock](zh/feature_key_lock.md) | ||
59 | * [Layouts](zh/feature_layouts.md) | ||
60 | * [Leader Key](zh/feature_leader_key.md) | ||
61 | * [Macros](zh/feature_macros.md) | ||
62 | * [Mouse Keys](zh/feature_mouse_keys.md) | ||
63 | * [One Shot Keys](zh/feature_advanced_keycodes.md#one-shot-keys) | ||
64 | * [Pointing Device](zh/feature_pointing_device.md) | ||
65 | * [PS/2 Mouse](zh/feature_ps2_mouse.md) | ||
66 | * [RGB Lighting](zh/feature_rgblight.md) | ||
67 | * [RGB Matrix](zh/feature_rgb_matrix.md) | ||
68 | * [Space Cadet Shift](zh/feature_space_cadet_shift.md) | ||
69 | * [Space Cadet Shift Enter](zh/feature_space_cadet_shift_enter.md) | ||
70 | * [Stenography](zh/feature_stenography.md) | ||
71 | * [Swap Hands](zh/feature_swap_hands.md) | ||
72 | * [Tap Dance](zh/feature_tap_dance.md) | ||
73 | * [Terminal](zh/feature_terminal.md) | ||
74 | * [Thermal Printer](zh/feature_thermal_printer.md) | ||
75 | * [Unicode](zh/feature_unicode.md) | ||
76 | * [Userspace](zh/feature_userspace.md) | ||
77 | * [US ANSI Shifted Keys](zh/keycodes_us_ansi_shifted.md) | ||
78 | |||
79 | * 對於製造商和遊戲模組 | ||
80 | * [Hand Wiring Guide](zh/hand_wire.md) | ||
81 | * [ISP Flashing Guide](zh/isp_flashing_guide.md) | ||
82 | * [ARM Debugging Guide](zh/arm_debugging.md) | ||
83 | * [I2C Driver](zh/i2c_driver.md) | ||
84 | |||
85 | * 為了更深入的了解 | ||
86 | * [How Keyboards Work](zh/how_keyboards_work.md) | ||
87 | * [Understanding QMK](zh/understanding_qmk.md) | ||
88 | |||
89 | * 其它主題 | ||
90 | * [Using Eclipse with QMK](zh/eclipse.md) | ||
91 | |||
92 | * QMK內部(進行中) | ||
93 | * [Defines](zh/internals_defines.md) | ||
94 | * [Input Callback Reg](zh/internals_input_callback_reg.md) | ||
95 | * [Midi Device](zh/internals_midi_device.md) | ||
96 | * [Midi Device Setup Process](zh/internals_midi_device_setup_process.md) | ||
97 | * [Midi Util](zh/internals_midi_util.md) | ||
98 | * [Send Functions](zh/internals_send_functions.md) | ||
99 | * [Sysex Tools](zh/internals_sysex_tools.md) | ||