aboutsummaryrefslogtreecommitdiff
path: root/docs/zh-cn/_summary.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/zh-cn/_summary.md')
-rw-r--r--docs/zh-cn/_summary.md322
1 files changed, 191 insertions, 131 deletions
diff --git a/docs/zh-cn/_summary.md b/docs/zh-cn/_summary.md
index cedcfbd52..8a710a9ec 100644
--- a/docs/zh-cn/_summary.md
+++ b/docs/zh-cn/_summary.md
@@ -1,133 +1,193 @@
1* [完全菜鸟指南](zh-cn/newbs.md) 1<!--for translators, see first: zh-cn/reference_glossary.md#terms-of-zh-cn-translate -->
2* 新手教程
3 * [介绍](zh-cn/newbs.md)
2 * [入门](zh-cn/newbs_getting_started.md) 4 * [入门](zh-cn/newbs_getting_started.md)
3 * [构建你的第一个固件](zh-cn/newbs_building_firmware.md) 5 * [构建第一个固件](zh-cn/newbs_building_firmware.md)
4 * [刷新固件](zh-cn/newbs_flashing.md) 6 * [刷写固件](zh-cn/newbs_flashing.md)
5 * [测试和调试](zh-cn/newbs_testing_debugging.md) 7 * [寻求帮助](zh-cn/support.md)
6 * [Git最佳实践](zh-cn/newbs_git_best_practices.md) 8 * [其它资源](zh-cn/newbs_learn_more_resources.md)
7 * [使用你分叉(fork)的主分支(master)](zh-cn/newbs_git_using_your_master_branch.md) 9 * [QMK大纲](zh-cn/syllabus.md)
8 * [解决合并冲突](zh-cn/newbs_git_resolving_merge_conflicts.md) 10
9 * [重新同步一个分支](zh-cn/newbs_git_resynchronize_a_branch.md) 11* FAQ
10 * [学习资源](zh-cn/newbs_learn_more_resources.md) 12 * [常规FAQ](zh-cn/faq_general.md)
11 13 * [构建/编译QMK](zh-cn/faq_build.md)
12* [QMK基础](zh-cn/README.md) 14 * [QMK问题排查](zh-cn/faq_misc.md)
13 * [QMK简介](zh-cn/getting_started_introduction.md) 15 * [调试QMK](zh-cn/faq_debug.md)
14 * [QMK命令行工具](zh-cn/cli.md) 16 * [键映射FAQ](zh-cn/faq_keymap.md)
15 * [QMK命令行工具配置](zh-cn/cli_configuration.md) 17 * [充分利用AVR的存储空间](zh-cn/squeezing_avr.md)
16 * [向QMK贡献代码](zh-cn/contributing.md)
17 * [如何使用GitHub](zh-cn/getting_started_github.md)
18 * [获得帮助](zh-cn/getting_started_getting_help.md)
19
20* [非兼容性修改](zh-cn/breaking_changes.md)
21 * [我的PR已经被标记为非兼容性修改](zh-cn/breaking_changes_instructions.md)
22 * [2019年8月30日](zh-cn/ChangeLog/20190830.md)
23
24* [问题与解答](zh-cn/faq.md)
25 * [一般问题](zh-cn/faq_general.md)
26 * [构建/编译](zh-cn/faq_build.md)
27 * [调试/故障排除](zh-cn/faq_debug.md)
28 * [布局](zh-cn/faq_keymap.md)
29 * [Zadig驱动安装](zh-cn/driver_installation_zadig.md)
30
31* 详细指南
32 * [安装构建工具](zh-cn/getting_started_build_tools.md)
33 * [vagrant指南](zh-cn/getting_started_vagrant.md)
34 * [构建/编译指南](zh-cn/getting_started_make_guide.md)
35 * [刷新固件](zh-cn/flashing.md)
36 * [定制功能](zh-cn/custom_quantum_functions.md)
37 * [布局概述](zh-cn/keymap.md)
38
39* [硬件](zh-cn/hardware.md)
40 * [兼容的单片机](zh-cn/compatible_microcontrollers.md)
41 * [AVR处理器](zh-cn/hardware_avr.md)
42 * [驱动](zh-cn/hardware_drivers.md)
43
44* 参考
45 * [键盘指南](zh-cn/hardware_keyboard_guidelines.md)
46 * [配置选项](zh-cn/config_options.md)
47 * [键码](zh-cn/keycodes.md)
48 * [代码书写规范 - C](zh-cn/coding_conventions_c.md)
49 * [代码书写规范 - Python](zh-cn/coding_conventions_python.md)
50 * [文档书写规范](zh-cn/documentation_best_practices.md)
51 * [文档模板](zh-cn/documentation_templates.md)
52 * [术语表](zh-cn/reference_glossary.md) 18 * [术语表](zh-cn/reference_glossary.md)
53 * [单元测试](zh-cn/unit_testing.md) 19
54 * [实用函数](zh-cn/ref_functions.md) 20* 配置器(Configurator)
55 * [配置器支持](zh-cn/reference_configurator_support.md) 21 * [总览](zh-cn/newbs_building_firmware_configurator.md)
56 * [info.json 格式](zh-cn/reference_info_json.md) 22 * [入门](zh-cn/configurator_step_by_step.md)
57 * [Python 命令行开发](zh-cn/cli_development.md) 23 * [问题排查](zh-cn/configurator_troubleshooting.md)
58 24 * [框架](zh-cn/configurator_architecture.md)
59* [特性](zh-cn/features.md) 25 * QMK API
60 * [基本键码](zh-cn/keycodes_basic.md) 26 * [总览](zh-cn/api_overview.md)
61 * [US ANSI控制码](zh-cn/keycodes_us_ansi_shifted.md) 27 * [API文档](zh-cn/api_docs.md)
62 * [量子键码](zh-cn/quantum_keycodes.md) 28 * [键盘支持](zh-cn/reference_configurator_support.md)
63 * [高级键码](zh-cn/feature_advanced_keycodes.md) 29 * [添加默认键映射](zh-cn/configurator_default_keymaps.md)
64 * [音频](zh-cn/feature_audio.md) 30
65 * [自动shift](zh-cn/feature_auto_shift.md) 31* CLI
66 * [背光](zh-cn/feature_backlight.md) 32 * [总览](zh-cn/cli.md)
67 * [蓝牙](zh-cn/feature_bluetooth.md) 33 * [配置](zh-cn/cli_configuration.md)
68 * [热改键](zh-cn/feature_bootmagic.md) 34 * [命令](zh-cn/cli_commands.md)
69 * [组合](zh-cn/feature_combo) 35 * [Tab补全](zh-cn/cli_tab_complete.md)
70 * [命令](zh-cn/feature_command.md) 36
71 * [消抖 API](zh-cn/feature_debounce_type.md) 37* 使用QMK
72 * [拨动开关](zh-cn/feature_dip_switch.md) 38 * 导览
73 * [动态宏指令](zh-cn/feature_dynamic_macros.md) 39 * [功能定制](zh-cn/custom_quantum_functions.md)
74 * [编码器](zh-cn/feature_encoders.md) 40 * [利用Zadig安装驱动](zh-cn/driver_installation_zadig.md)
75 * [重音号Esc复合键](zh-cn/feature_grave_esc.md) 41 * [极简式制作](zh-cn/easy_maker.md)
76 * [触摸反馈](zh-cn/feature_haptic_feedback.md) 42 * [键映射总览](zh-cn/keymap.md)
77 * [HD44780 LCD控制器](zh-cn/feature_hd44780.md) 43 * 开发环境
78 * [自锁键](zh-cn/feature_key_lock.md) 44 * [Docker指南](zh-cn/getting_started_docker.md)
79 * [布局](zh-cn/feature_layouts.md) 45 * [Vagrant指南](zh-cn/getting_started_vagrant.md)
80 * [前导键](zh-cn/feature_leader_key.md) 46 * 刷写(Flashing)
81 * [LED阵列](zh-cn/feature_led_matrix.md) 47 * [刷写](zh-cn/flashing.md)
82 * [宏指令](zh-cn/feature_macros.md) 48 * [刷写ATmega32A (ps2avrgb)](zh-cn/flashing_bootloadhid.md)
83 * [鼠标键](zh-cn/feature_mouse_keys.md) 49 * IDE
84 * [OLED驱动](zh-cn/feature_oled_driver.md) 50 * [在Eclipse中使用QMK](zh-cn/other_eclipse.md)
85 * [一键功能](zh-cn/one_shot_keys.md) 51 * [在VSCode中使用QMK](zh-cn/other_vscode.md)
86 * [指针设备](zh-cn/feature_pointing_device.md) 52 * Git最佳实践
87 * [PS/2鼠标](zh-cn/feature_ps2_mouse.md) 53 * [介绍](zh-cn/newbs_git_best_practices.md)
88 * [RGB灯光](zh-cn/feature_rgblight.md) 54 * [你自己的副本](zh-cn/newbs_git_using_your_master_branch.md)
89 * [RGB矩阵](zh-cn/feature_rgb_matrix.md) 55 * [冲突合并](zh-cn/newbs_git_resolving_merge_conflicts.md)
90 * [空格候补换挡](zh-cn/feature_space_cadet.md) 56 * [基于你的分支修复](zh-cn/newbs_git_resynchronize_a_branch.md)
91 * [分体键盘](zh-cn/feature_split_keyboard.md) 57 * 键盘组装
92 * [速录机](zh-cn/feature_stenography.md) 58 * [飞线指南](zh-cn/hand_wire.md)
93 * [换手](zh-cn/feature_swap_hands.md) 59 * [ISP刷写指南](zh-cn/isp_flashing_guide.md)
94 * [多击键](zh-cn/feature_tap_dance.md) 60
95 * [终端](zh-cn/feature_terminal.md) 61 * 键码入门
96 * [热敏打印机](zh-cn/feature_thermal_printer.md) 62 * [键码汇总](zh-cn/keycodes.md)
97 * [Unicode](zh-cn/feature_unicode.md) 63 * [基础键码](zh-cn/keycodes_basic.md)
98 * [用户空间](zh-cn/feature_userspace.md) 64 * [语言特定的键码](zh-cn/reference_keymap_extras.md)
99 * [速度键](zh-cn/feature_velocikey.md) 65 * [修饰键](zh-cn/feature_advanced_keycodes.md)
100 66 * [原子键码](zh-cn/quantum_keycodes.md)
101* 制造和定制者指南 67 * [Magic键码](zh-cn/keycodes_magic.md)
102 * [手工连线指南](zh-cn/hand_wire.md) 68
103 * [ISP刷新指南](zh-cn/isp_flashing_guide.md) 69 * 键码进阶
104 * [ARM调试指南](zh-cn/arm_debugging.md) 70 * [指令](zh-cn/feature_command.md)
105 * [ADC设备](zh-cn/adc_driver.md) 71 * [动态宏](zh-cn/feature_dynamic_macros.md)
106 * [I2C设备](zh-cn/i2c_driver.md) 72 * [Grave Escape](zh-cn/feature_grave_esc.md)
107 * [SPI设备](zh-cn/spi_driver.md) 73 * [前导键](zh-cn/feature_leader_key.md)
108 * [WS2812设备](zh-cn/ws2812_driver.md) 74 * [Mod-Tap](zh-cn/mod_tap.md)
109 * [EEPROM设备](zh-cn/eeprom_driver.md) 75 * [宏](zh-cn/feature_macros.md)
110 * [GPIO控制](zh-cn/internals_gpio_control.md) 76 * [鼠标键](zh-cn/feature_mouse_keys.md)
111 * [自定义键盘矩阵](zh-cn/custom_matrix.md) 77 * [Space Cadet Shift](zh-cn/feature_space_cadet.md)
112 * [Proton C转换](zh-cn/proton_c_conversion.md) 78 * [US ANSI上档键值](zh-cn/keycodes_us_ansi_shifted.md)
113 79
114* 深入了解 80 * 软件特性
115 * [键盘工作原理](zh-cn/how_keyboards_work.md) 81 * [自动Shift](zh-cn/feature_auto_shift.md)
116 * [深入了解QMK](zh-cn/understanding_qmk.md) 82 * [组合键](zh-cn/feature_combo.md)
117 83 * [防抖API](zh-cn/feature_debounce_type.md)
118* 其他话题 84 * [按键锁定](zh-cn/feature_key_lock.md)
119 * [使用Eclipse开发QMK](zh-cn/other_eclipse.md) 85 * [按键重定义](zh-cn/feature_key_overrides.md)
120 * [使用VSCode开发QMK](zh-cn/other_vscode.md) 86 * [层](zh-cn/feature_layers.md)
121 * [支持](zh-cn/getting_started_getting_help.md) 87 * [粘滞键](zh-cn/one_shot_keys.md)
122 * [翻译QMK文档](zh-cn/translating.md) 88 * [光标设备](zh-cn/feature_pointing_device.md)
123 89 * [原生HID](zh-cn/feature_rawhid.md)
124* QMK 内构 (正在编写) 90 * [Sequencer](zh-cn/feature_sequencer.md)
125 * [定义](zh-cn/internals_defines.md) 91 * [换手](zh-cn/feature_swap_hands.md)
126 * [输入回调寄存器](zh-cn/internals_input_callback_reg.md) 92 * [一键多用](zh-cn/feature_tap_dance.md)
127 * [Midi设备](zh-cn/internals_midi_device.md) 93 * [点按配置](zh-cn/tap_hold.md)
128 * [Midi设备配置过程](zh-cn/internals_midi_device_setup_process.md) 94 * [终端](zh-cn/feature_terminal.md)
129 * [Midi工具库](zh-cn/internals_midi_util.md) 95 * [Unicode](zh-cn/feature_unicode.md)
130 * [发送函数](zh-cn/internals_send_functions.md) 96 * [用户空间](zh-cn/feature_userspace.md)
131 * [Sysex工具](zh-cn/internals_sysex_tools.md) 97 * [WPM计算](zh-cn/feature_wpm.md)
132<!--fromen:20200126-6:03AM(GMT+8)--> 98
133<!--cn:20200211-11:04AM(GMT+8)--> 99 * 硬件特性
100 * 显示
101 * [HD44780 LCD控制器](zh-cn/feature_hd44780.md)
102 * [ST7565 LCD驱动](zh-cn/feature_st7565.md)
103 * [OLED驱动](zh-cn/feature_oled_driver.md)
104 * 灯效
105 * [背光](zh-cn/feature_backlight.md)
106 * [LED矩阵](zh-cn/feature_led_matrix.md)
107 * [RGB灯光](zh-cn/feature_rgblight.md)
108 * [RGB矩阵](zh-cn/feature_rgb_matrix.md)
109 * [音频](zh-cn/feature_audio.md)
110 * [蓝牙](zh-cn/feature_bluetooth.md)
111 * [Bootmagic Lite](zh-cn/feature_bootmagic.md)
112 * [自定义矩阵](zh-cn/custom_matrix.md)
113 * [Digitizer](zh-cn/feature_digitizer.md)
114 * [拨动开关（DIP Switch）](zh-cn/feature_dip_switch.md)
115 * [编码器（旋钮）](zh-cn/feature_encoders.md)
116 * [触摸反馈](zh-cn/feature_haptic_feedback.md)
117 * [摇杆](zh-cn/feature_joystick.md)
118 * [LED指示](zh-cn/feature_led_indicators.md)
119 * [MIDI](zh-cn/feature_midi.md)
120 * [Proton C转换](zh-cn/proton_c_conversion.md)
121 * [PS/2鼠标](zh-cn/feature_ps2_mouse.md)
122 * [分体式键盘](zh-cn/feature_split_keyboard.md)
123 * [速记](zh-cn/feature_stenography.md)
124 * [热敏打印机](zh-cn/feature_thermal_printer.md)
125 * [Velocikey](zh-cn/feature_velocikey.md)
126
127* QMK开发
128 * [PR Checklist](zh-cn/pr_checklist.md)
129 * 打破兼容的改动
130 * [总览](zh-cn/breaking_changes.md)
131 * [我的PR已打上标记](zh-cn/breaking_changes_instructions.md)
132 * [近期的变更日志(Changelog)](zh-cn/ChangeLog/20210529.md "QMK v0.13.0 - 2021 May 29")
133 * [更早期的不兼容改动](zh-cn/breaking_changes_history.md)
134
135 * C语言开发
136 * [ARM调试指引](zh-cn/arm_debugging.md)
137 * [AVR处理器](zh-cn/hardware_avr.md)
138 * [C编码规范](zh-cn/coding_conventions_c.md)
139 * [兼容的微处理器](zh-cn/compatible_microcontrollers.md)
140 * [驱动](zh-cn/hardware_drivers.md)
141 * [ADC驱动](zh-cn/adc_driver.md)
142 * [Audio驱动](zh-cn/audio_driver.md)
143 * [I2C驱动](zh-cn/i2c_driver.md)
144 * [SPI驱动](zh-cn/spi_driver.md)
145 * [WS2812驱动](zh-cn/ws2812_driver.md)
146 * [EEPROM驱动](zh-cn/eeprom_driver.md)
147 * [串口驱动](zh-cn/serial_driver.md)
148 * [UART驱动](zh-cn/uart_driver.md)
149 * [操控GPIO](zh-cn/internals_gpio_control.md)
150 * [键盘开发指引](zh-cn/hardware_keyboard_guidelines.md)
151
152 * Python开发
153 * [编码规范](zh-cn/coding_conventions_python.md)
154 * [QMK CLI开发](zh-cn/cli_development.md)
155
156 * 配置器开发
157 * QMK API
158 * [开发环境](zh-cn/api_development_environment.md)
159 * [架构总览](zh-cn/api_development_overview.md)
160
161 * 硬件平台开发
162 * Arm/ChibiOS
163 * [选择MCU](zh-cn/platformdev_selecting_arm_mcu.md)
164 * [启动引导](zh-cn/platformdev_chibios_earlyinit.md)
165
166 * QMK参考信息
167 * [参与到QMK](zh-cn/contributing.md)
168 * [翻译QMK文档](zh-cn/translating.md)<!--but should we translate this? currently keep it fallback-->
169 * [配置](zh-cn/config_options.md)
170 * [数据驱动配置](zh-cn/data_driven_config.md)
171 * [Make指引](zh-cn/getting_started_make_guide.md)
172 * [编写文档的最佳实践](zh-cn/documentation_best_practices.md)
173 * [文档模板](zh-cn/documentation_templates.md)
174 * [贡献配列到社区](zh-cn/feature_layouts.md)
175 * [单元测试](zh-cn/unit_testing.md)
176 * [常用函数](zh-cn/ref_functions.md)
177 * [info.json参考资料](zh-cn/reference_info_json.md)
178
179 * 深入了解
180 * [键盘工作原理](zh-cn/how_keyboards_work.md)
181 * [键盘矩阵原理](zh-cn/how_a_matrix_works.md)
182 * [了解QMK](zh-cn/understanding_qmk.md)
183
184 * QMK内部细节 (编辑中)
185 * [定义](zh-cn/internals_defines.md)
186 * [输入回调的注册](zh-cn/internals_input_callback_reg.md)
187 * [Midi设备](zh-cn/internals_midi_device.md)
188 * [Midi设备驱动流程](zh-cn/internals_midi_device_setup_process.md)
189 * [Midi辅助功能](zh-cn/internals_midi_util.md)
190 * [发送函数](zh-cn/internals_send_functions.md)
191 * [Sysex工具](zh-cn/internals_sysex_tools.md)
192
193<!--fromen:20211014-12:00(GMT+8) commit 04cf161aa01fd433b5dae69d9fd31569ed5dca59-->
generated by cgit v1.2.3 (git 2.25.1) at 2025-07-17 08:08:46 +0000