summaryrefslogtreecommitdiff
path: root/docs/_sidebar.json
diff options
context:
space:
mode:
Diffstat (limited to 'docs/_sidebar.json')
-rw-r--r--docs/_sidebar.json309
1 files changed, 309 insertions, 0 deletions
diff --git a/docs/_sidebar.json b/docs/_sidebar.json
new file mode 100644
index 0000000000..f1b7c156e6
--- /dev/null
+++ b/docs/_sidebar.json
@@ -0,0 +1,309 @@
1[
2 {
3 "text": "Tutorial",
4 "items": [
5 { "text": "Introduction", "link": "/newbs" },
6 { "text": "Setup", "link": "/newbs_getting_started" },
7 { "text": "Building Your First Firmware", "link": "/newbs_building_firmware" },
8 { "text": "Flashing Firmware", "link": "/newbs_flashing" },
9 { "text": "Getting Help/Support", "link": "/support" },
10 { "text": "External Userspace", "link": "/newbs_external_userspace" },
11 { "text": "Other Resources", "link": "/newbs_learn_more_resources" },
12 { "text": "Syllabus", "link": "/syllabus" }
13 ]
14 },
15 {
16 "text": "FAQs",
17 "items": [
18 { "text": "General FAQ", "link": "/faq_general" },
19 { "text": "Build/Compile QMK", "link": "/faq_build" },
20 { "text": "Troubleshooting QMK", "link": "/faq_misc" },
21 { "text": "Debugging QMK", "link": "/faq_debug" },
22 { "text": "Keymap FAQ", "link": "/faq_keymap" },
23 { "text": "Squeezing Space from AVR", "link": "/squeezing_avr" },
24 { "text": "Glossary", "link": "/reference_glossary" }
25 ]
26 },
27 {
28 "text": "Configurator",
29 "items": [
30 { "text": "Overview", "link": "/newbs_building_firmware_configurator" },
31 { "text": "Step by Step", "link": "/configurator_step_by_step" },
32 { "text": "Troubleshooting", "link": "/configurator_troubleshooting" },
33 { "text": "Architecture", "link": "/configurator_architecture" },
34 {
35 "text": "QMK API",
36 "items": [
37 { "text": "Overview", "link": "/api_overview" },
38 { "text": "API Documentation", "link": "/api_docs" },
39 { "text": "Keyboard Support", "link": "/reference_configurator_support" },
40 { "text": "Adding Default Keymaps", "link": "/configurator_default_keymaps" }
41 ]
42 }
43 ]
44 },
45 {
46 "text": "CLI",
47 "items": [
48 { "text": "Overview", "link": "/cli" },
49 { "text": "Configuration", "link": "/cli_configuration" },
50 { "text": "Commands", "link": "/cli_commands" },
51 { "text": "Tab Completion", "link": "/cli_tab_complete" }
52 ]
53 },
54 {
55 "text": "Using QMK",
56 "items": [
57 {
58 "text": "Guides",
59 "items": [
60 { "text": "Customizing Functionality", "link": "/custom_quantum_functions" },
61 { "text": "Driver Installation with Zadig", "link": "/driver_installation_zadig" },
62 { "text": "Keymap Overview", "link": "/keymap" },
63 {
64 "text": "Development Environments",
65 "items": [{ "text": "Docker Guide", "link": "/getting_started_docker" }]
66 },
67 {
68 "text": "Flashing",
69 "items": [
70 { "text": "Flashing", "link": "/flashing" },
71 { "text": "Flashing ATmega32A (ps2avrgb)", "link": "/flashing_bootloadhid" }
72 ]
73 },
74 {
75 "text": "IDEs",
76 "items": [
77 { "text": "Using Eclipse with QMK", "link": "/other_eclipse" },
78 { "text": "Using VSCode with QMK", "link": "/other_vscode" }
79 ]
80 },
81 {
82 "text": "Git Best Practices",
83 "items": [
84 { "text": "Introduction", "link": "/newbs_git_best_practices" },
85 { "text": "Your Fork", "link": "/newbs_git_using_your_master_branch" },
86 { "text": "Merge Conflicts", "link": "/newbs_git_resolving_merge_conflicts" },
87 { "text": "Fixing Your Branch", "link": "/newbs_git_resynchronize_a_branch" }
88 ]
89 }
90 ]
91 },
92 {
93 "text": "Simple Keycodes",
94 "items": [
95 { "text": "Full List", "link": "/keycodes" },
96 { "text": "Basic Keycodes", "link": "/keycodes_basic" },
97 { "text": "Language-Specific Keycodes", "link": "/reference_keymap_extras" },
98 { "text": "Modifier Keys", "link": "/feature_advanced_keycodes" },
99 { "text": "Quantum Keycodes", "link": "/quantum_keycodes" },
100 { "text": "Magic Keycodes", "link": "/keycodes_magic" }
101 ]
102 },
103 {
104 "text": "Advanced Keycodes",
105 "items": [
106 { "text": "Command", "link": "/feature_command" },
107 { "text": "Dynamic Macros", "link": "/feature_dynamic_macros" },
108 { "text": "Grave Escape", "link": "/feature_grave_esc" },
109 { "text": "Leader Key", "link": "/feature_leader_key" },
110 { "text": "Mod-Tap", "link": "/mod_tap" },
111 { "text": "Macros", "link": "/feature_macros" },
112 { "text": "Mouse Keys", "link": "/feature_mouse_keys" },
113 { "text": "Programmable Button", "link": "/feature_programmable_button" },
114 { "text": "Repeat Key", "link": "/feature_repeat_key" },
115 { "text": "Space Cadet Shift", "link": "/feature_space_cadet" },
116 { "text": "US ANSI Shifted Keys", "link": "/keycodes_us_ansi_shifted" }
117 ]
118 },
119 {
120 "text": "Software Features",
121 "items": [
122 { "text": "Auto Shift", "link": "/feature_auto_shift" },
123 { "text": "Autocorrect", "link": "/feature_autocorrect" },
124 { "text": "Caps Word", "link": "/feature_caps_word" },
125 { "text": "Combos", "link": "/feature_combo" },
126 { "text": "Debounce API", "link": "/feature_debounce_type" },
127 { "text": "Digitizer", "link": "/feature_digitizer" },
128 { "text": "EEPROM", "link": "/feature_eeprom" },
129 { "text": "Key Lock", "link": "/feature_key_lock" },
130 { "text": "Key Overrides", "link": "/feature_key_overrides" },
131 { "text": "Layers", "link": "/feature_layers" },
132 { "text": "One Shot Keys", "link": "/one_shot_keys" },
133 { "text": "OS Detection", "link": "/feature_os_detection" },
134 { "text": "Raw HID", "link": "/feature_rawhid" },
135 { "text": "Secure", "link": "/feature_secure" },
136 { "text": "Send String", "link": "/feature_send_string" },
137 { "text": "Sequencer", "link": "/feature_sequencer" },
138 { "text": "Swap Hands", "link": "/feature_swap_hands" },
139 { "text": "Tap Dance", "link": "/feature_tap_dance" },
140 { "text": "Tap-Hold Configuration", "link": "/tap_hold" },
141 { "text": "Tri Layer", "link": "/feature_tri_layer" },
142 { "text": "Unicode", "link": "/feature_unicode" },
143 { "text": "Userspace", "link": "/feature_userspace" },
144 { "text": "WPM Calculation", "link": "/feature_wpm" }
145 ]
146 },
147 {
148 "text": "Hardware Features",
149 "items": [
150 {
151 "text": "Displays",
152 "items": [
153 {
154 "text": "Quantum Painter",
155 "link": "quantum_painter",
156 "items": [
157 { "text": "Quantum Painter LVGL Integration", "link": "/quantum_painter_lvgl" }
158 ]
159 },
160 { "text": "HD44780 LCD Driver", "link": "/feature_hd44780" },
161 { "text": "ST7565 LCD Driver", "link": "/feature_st7565" },
162 { "text": "OLED Driver", "link": "/feature_oled_driver" }
163 ]
164 },
165 {
166 "text": "Lighting",
167 "items": [
168 { "text": "Backlight", "link": "/feature_backlight" },
169 { "text": "LED Matrix", "link": "/feature_led_matrix" },
170 { "text": "RGB Lighting", "link": "/feature_rgblight" },
171 { "text": "RGB Matrix", "link": "/feature_rgb_matrix" }
172 ]
173 },
174 { "text": "Audio", "link": "/feature_audio" },
175 { "text": "Bluetooth", "link": "/feature_bluetooth" },
176 { "text": "Bootmagic Lite", "link": "/feature_bootmagic" },
177 { "text": "Converters", "link": "/feature_converters" },
178 { "text": "Custom Matrix", "link": "/custom_matrix" },
179 { "text": "DIP Switch", "link": "/feature_dip_switch" },
180 { "text": "Encoders", "link": "/feature_encoders" },
181 { "text": "Haptic Feedback", "link": "/feature_haptic_feedback" },
182 { "text": "Joystick", "link": "/feature_joystick" },
183 { "text": "LED Indicators", "link": "/feature_led_indicators" },
184 { "text": "MIDI", "link": "/feature_midi" },
185 { "text": "Pointing Device", "link": "/feature_pointing_device" },
186 { "text": "PS/2 Mouse", "link": "/feature_ps2_mouse" },
187 { "text": "Split Keyboard", "link": "/feature_split_keyboard" },
188 { "text": "Stenography", "link": "/feature_stenography" }
189 ]
190 },
191 {
192 "text": "Keyboard Building",
193 "items": [
194 { "text": "Easy Maker for One Offs", "link": "/easy_maker" },
195 { "text": "Porting Keyboards", "link": "/porting_your_keyboard_to_qmk" },
196 { "text": "Hand Wiring Guide", "link": "/hand_wire" },
197 { "text": "ISP Flashing Guide", "link": "/isp_flashing_guide" }
198 ]
199 }
200 ]
201 },
202 {
203 "text": "Developing QMK",
204 "items": [
205 { "text": "PR Checklist", "link": "/pr_checklist" },
206 {
207 "text": "Breaking Changes",
208 "items": [
209 { "text": "Overview", "link": "/breaking_changes" },
210 { "text": "My Pull Request Was Flagged", "link": "/breaking_changes_instructions" },
211 {
212 "text": "Most Recent ChangeLog",
213 "link": "/ChangeLog/20240526"
214 },
215 { "text": "Past Breaking Changes", "link": "/breaking_changes_history" }
216 ]
217 },
218
219 {
220 "text": "C Development",
221 "items": [
222 { "text": "ARM Debugging Guide", "link": "/arm_debugging" },
223 { "text": "Coding Conventions", "link": "/coding_conventions_c" },
224 { "text": "Compatible Microcontrollers", "link": "/compatible_microcontrollers" },
225 {
226 "text": "Drivers",
227 "link": "hardware_drivers",
228 "items": [
229 { "text": "ADC Driver", "link": "/adc_driver" },
230 { "text": "APA102 Driver", "link": "/apa102_driver" },
231 { "text": "Audio Driver", "link": "/audio_driver" },
232 { "text": "I2C Driver", "link": "/i2c_driver" },
233 { "text": "SPI Driver", "link": "/spi_driver" },
234 { "text": "WS2812 Driver", "link": "/ws2812_driver" },
235 { "text": "EEPROM Driver", "link": "/eeprom_driver" },
236 { "text": "Flash Driver", "link": "/flash_driver" },
237 { "text": "'serial' Driver", "link": "/serial_driver" },
238 { "text": "UART Driver", "link": "/uart_driver" }
239 ]
240 },
241 { "text": "GPIO Controls", "link": "/gpio_control" },
242 { "text": "Keyboard Guidelines", "link": "/hardware_keyboard_guidelines" }
243 ]
244 },
245
246 {
247 "text": "Python Development",
248 "items": [
249 { "text": "Coding Conventions", "link": "/coding_conventions_python" },
250 { "text": "QMK CLI Development", "link": "/cli_development" }
251 ]
252 },
253
254 {
255 "text": "Configurator Development",
256 "items": [
257 {
258 "text": "QMK API",
259 "items": [
260 { "text": "Development Environment", "link": "/api_development_environment" },
261 { "text": "Architecture Overview", "link": "/api_development_overview" }
262 ]
263 }
264 ]
265 },
266
267 {
268 "text": "Hardware Platform Development",
269 "items": [
270 {
271 "text": "Arm/ChibiOS",
272 "items": [
273 { "text": "Selecting an MCU", "link": "/platformdev_selecting_arm_mcu" },
274 { "text": "Early initialization", "link": "/platformdev_chibios_earlyinit" },
275 { "text": "Raspberry Pi RP2040", "link": "/platformdev_rp2040" },
276 { "text": "Proton C", "link": "/platformdev_proton_c" },
277 { "text": "WeAct Blackpill F4x1", "link": "/platformdev_blackpill_f4x1" }
278 ]
279 }
280 ]
281 },
282
283 {
284 "text": "QMK Reference",
285 "items": [
286 { "text": "Contributing to QMK", "link": "/contributing" },
287 { "text": "Config Options", "link": "/config_options" },
288 { "text": "Data Driven Configuration", "link": "/data_driven_config" },
289 { "text": "Make Documentation", "link": "/getting_started_make_guide" },
290 { "text": "Documentation Best Practices", "link": "/documentation_best_practices" },
291 { "text": "Documentation Templates", "link": "/documentation_templates" },
292 { "text": "Community Layouts", "link": "/feature_layouts" },
293 { "text": "Unit Testing", "link": "/unit_testing" },
294 { "text": "Useful Functions", "link": "/ref_functions" },
295 { "text": "info.json Format", "link": "/reference_info_json" }
296 ]
297 },
298
299 {
300 "text": "For a Deeper Understanding",
301 "items": [
302 { "text": "How Keyboards Work", "link": "/how_keyboards_work" },
303 { "text": "How a Matrix Works", "link": "/how_a_matrix_works" },
304 { "text": "Understanding QMK", "link": "/understanding_qmk" }
305 ]
306 }
307 ]
308 }
309]
generated by cgit v1.2.3 (git 2.25.1) at 2026-09-03 07:37:00 +0000