..
ChangeLog
2020 February 29 Breaking Changes Update ( #8064 )
2020-02-29 11:59:30 -08:00
de
Rework the newbs guide around the qmk cli
2020-03-05 16:00:10 -08:00
es
overhaul the newbs guide
2020-03-05 16:00:10 -08:00
fr-fr
overhaul the newbs guide
2020-03-05 16:00:10 -08:00
gitbook /images
RGB improvements ( #1684 )
2017-09-06 14:49:19 -07:00
he-il
Rework the newbs guide around the qmk cli
2020-03-05 16:00:10 -08:00
ja
overhaul the newbs guide
2020-03-05 16:00:10 -08:00
pt-br
Rework the newbs guide around the qmk cli
2020-03-05 16:00:10 -08:00
ru-ru
Rework the newbs guide around the qmk cli
2020-03-05 16:00:10 -08:00
zh-cn
Rework the newbs guide around the qmk cli
2020-03-05 16:00:10 -08:00
.nojekyll
Use docsfy to replace gitbook
2018-05-07 22:46:26 -07:00
_langs.md
[Docs] add README translation in portuguese ( #7016 )
2019-12-10 10:19:12 -08:00
_summary.md
split Hand Wire Preamble to a separate doc
2020-03-05 16:00:10 -08:00
adc_driver.md
Improve support and docs for ADC driver ( #7191 )
2019-12-08 12:11:29 +11:00
api_development_environment.md
Add API documentation
2020-03-05 16:00:10 -08:00
api_development_overview.md
Add API documentation
2020-03-05 16:00:10 -08:00
api_docs.md
Add API documentation
2020-03-05 16:00:10 -08:00
api_overview.md
Add API documentation
2020-03-05 16:00:10 -08:00
arm_debugging.md
[Docs] fix docs ( #7642 )
2019-12-21 11:00:22 +00:00
breaking_changes.md
Fix the Breaking Changes doc again
2020-02-29 20:46:48 -08:00
breaking_changes_instructions.md
suggestions by skullydazed
2020-01-25 18:15:07 -08:00
cli.md
remove some unnecessary external links
2020-03-05 16:00:10 -08:00
cli_dev_configuration.md
More sidebar organization
2020-03-05 16:00:10 -08:00
cli_development.md
Add flake8 to our test suite and fix all errors ( #7379 )
2019-11-20 14:54:18 -08:00
CNAME
Create CNAME
2018-05-21 16:29:37 -04:00
coding_conventions_c.md
Minor grammar and filename fixes in docs ( #7559 )
2019-12-07 23:19:18 +11:00
coding_conventions_python.md
Add a note explaining how to run tests
2020-01-14 07:52:14 -08:00
compatible_microcontrollers.md
[Doc] Tidy up compatible MCUs docs ( #7295 )
2019-11-08 18:34:25 -08:00
config_options.md
New feature: PERMISSIVE_HOLD_PER_KEY ( #7994 )
2020-02-25 13:25:52 -05:00
configurator_step_by_step.md
Polish Configurator section
2020-03-05 16:00:10 -08:00
configurator_troubleshooting.md
Polish Configurator section
2020-03-05 16:00:10 -08:00
contributing.md
Improve docs "Edit Document" footer
2019-12-18 14:01:13 +11:00
custom_matrix.md
Add docs for 'CUSTOM_MATRIX = lite' ( #7906 )
2020-01-18 12:56:33 +11:00
custom_quantum_functions.md
Add per-key IGNORE_MOD_TAP_INTERRUPT feature ( #7838 )
2020-01-10 02:48:06 -05:00
documentation_best_practices.md
Fix up info boxes.
2018-05-07 22:46:26 -07:00
documentation_templates.md
Doc fix to conform with #7221 ( #7392 )
2019-11-17 16:04:44 +00:00
driver_installation_zadig.md
Add a short explanation to Zadig the troubleshooting section ( #7110 )
2019-10-22 14:05:33 +11:00
eeprom_driver.md
Add customisable EEPROM driver selection ( #7274 )
2020-01-24 12:45:58 +11:00
faq_build.md
[Docs] Update macOS related issues in docs ( #7744 )
2019-12-31 14:33:54 +00:00
faq_debug.md
[Docs] Remove some outdated FAQ items ( #7607 )
2019-12-11 11:33:09 -08:00
faq_general.md
Rework the newbs guide around the qmk cli
2020-03-05 16:00:10 -08:00
faq_keymap.md
make custom_keycode_names.md a faq entry instead
2020-03-05 16:00:10 -08:00
feature_advanced_keycodes.md
break feature_advanced_keycodes.md up into multiple files
2020-03-05 16:00:10 -08:00
feature_audio.md
Added keycodes for swapping and unswapping the Control and OS keys ( #6110 )
2019-08-21 17:07:08 -07:00
feature_auto_shift.md
Smallish overhaul of Auto-Shift feature ( #6067 )
2019-11-03 09:52:01 -08:00
feature_backlight.md
2020 February 29 Breaking Changes Update ( #8064 )
2020-02-29 11:59:30 -08:00
feature_bluetooth.md
Update feature_bluetooth.md ( #7193 )
2019-10-30 09:43:01 +11:00
feature_bootmagic.md
Add short aliases for Magic keycodes ( #7541 )
2019-12-05 00:44:39 -08:00
feature_combo.md
Change "yu" to "you" in combo docs ( #6510 )
2019-08-08 18:10:16 +01:00
feature_command.md
Update IS_COMMAND definitions to use MOD_MASK_SHIFT ( #6348 )
2019-07-20 13:21:40 -07:00
feature_debounce_type.md
Update debounce docs ( #7355 )
2019-11-14 18:54:34 +00:00
feature_dip_switch.md
Add Dip Switch as a core feature ( #6140 )
2019-09-03 08:34:31 -07:00
feature_dynamic_macros.md
[Core] Convert Dynamic Macro to a Core Feature ( #5948 )
2019-11-04 22:59:13 -08:00
feature_encoders.md
2020 February 29 Breaking Changes Update ( #8064 )
2020-02-29 11:59:30 -08:00
feature_grave_esc.md
Document an annoyance with Grave Escape and macOS Terminal ( #5483 )
2019-03-24 17:11:26 -07:00
feature_haptic_feedback.md
Minor grammar and filename fixes in docs ( #7559 )
2019-12-07 23:19:18 +11:00
feature_hd44780.md
Remove build option firmware size impacts ( #6947 )
2019-10-18 18:14:49 -07:00
feature_key_lock.md
update one shot keys link ( #7020 )
2019-10-14 01:26:03 +01:00
feature_layouts.md
Add a mechanism for force building a particular community layout ( #5027 )
2019-02-14 20:14:26 -08:00
feature_leader_key.md
Send string keycode tweaks ( #7471 )
2019-11-25 23:16:58 -08:00
feature_led_matrix.md
Add documentation for led matrix
2019-02-10 15:37:12 -08:00
feature_macros.md
Add support for delays in send_string. ( #8244 )
2020-02-27 20:38:19 +11:00
feature_mouse_keys.md
Update mouse keys docs ( #5653 )
2019-04-19 23:18:06 -07:00
feature_oled_driver.md
Fix out of bound OLED font access ( #8145 )
2020-02-11 21:38:20 +00:00
feature_pointing_device.md
Fix some of the more obvious typos
2017-12-09 10:46:11 -05:00
feature_ps2_mouse.md
[Docs] Removed dead link ( #6922 )
2019-10-06 07:56:35 -07:00
feature_rgb_matrix.md
Configuration values for starting HSV and speed ( #7740 )
2020-01-18 20:11:33 +00:00
feature_rgblight.md
Add shift-to-invert to remaining directional RGB_* keycode pairs ( #7484 )
2019-11-28 22:00:29 +00:00
feature_space_cadet.md
Added mod carry over from press to release. ( #5866 )
2019-07-06 21:00:05 -07:00
feature_split_keyboard.md
Reduce SPLIT_USB_TIMEOUT by 500ms ( #7637 )
2020-02-04 19:37:04 -08:00
feature_stenography.md
Improve state/chord handling and clean up namespace
2018-04-07 17:12:44 -04:00
feature_swap_hands.md
fix swap_hands keycodes in documentation ( #3588 )
2018-08-07 14:20:29 -07:00
feature_tap_dance.md
[Docs] Explain Tap Dance interruption ( #5520 )
2019-11-16 09:20:49 -08:00
feature_terminal.md
Remove build option firmware size impacts ( #6947 )
2019-10-18 18:14:49 -07:00
feature_thermal_printer.md
Format keycode tables
2017-12-09 10:46:11 -05:00
feature_unicode.md
send_unicode_string(): Add support for code points > 0xFFFF (#8236 )
2020-02-25 12:54:51 +11:00
feature_userspace.md
Send string keycode tweaks ( #7471 )
2019-11-25 23:16:58 -08:00
feature_velocikey.md
Velocikey: Match RGB animation speed to typing speed ( #3754 )
2019-02-21 07:22:46 -08:00
flashing.md
update flashing.md
2020-03-05 16:00:10 -08:00
flashing_bootloadhid.md
Install bootloadHid as part of qmk_install ( #7463 )
2019-11-28 15:29:11 +00:00
fuse.txt
convert docs to lowercase and underscores
2017-06-10 14:58:24 -04:00
getting_started_getting_help.md
Rework the newbs guide around the qmk cli
2020-03-05 16:00:10 -08:00
getting_started_introduction.md
[Docs] update git command and directory name of documents ( #7619 )
2019-12-12 20:59:00 -08:00
getting_started_make_guide.md
Add docs for 'CUSTOM_MATRIX = lite' ( #7906 )
2020-01-18 12:56:33 +11:00
getting_started_vagrant.md
[Docs] Update getting_started_vagrant.md ( #7203 )
2019-10-30 11:53:48 -07:00
hand_wire.md
clean up Firmware Setup section in Hand Wire guide
2020-03-05 16:00:10 -08:00
hardware_avr.md
Remove apostrophe from various abbreviations' plural forms ( #7050 )
2019-10-22 13:47:43 +01:00
hardware_drivers.md
Add customisable EEPROM driver selection ( #7274 )
2020-01-24 12:45:58 +11:00
hardware_keyboard_guidelines.md
Fixed typos in documentation ( #6871 )
2019-10-02 16:41:32 -04:00
how_a_matrix_works.md
split Hand Wire Preamble to a separate doc
2020-03-05 16:00:10 -08:00
how_keyboards_work.md
Update URL for 60-keyboard.hwdb ( #7185 )
2019-10-28 02:41:22 +00:00
i2c_driver.md
[Docs] Update i2c_driver.md ( #6665 )
2019-09-03 10:09:58 -07:00
index.html
limit the TOC to H1 and H2
2020-03-05 16:00:10 -08:00
internals_defines.md
rename api docs to internals
2018-03-26 11:43:37 -07:00
internals_gpio_control.md
[Docs] Add AVR and ARM examples to GPIO Commands ( #6942 )
2019-10-07 19:08:14 -07:00
internals_input_callback_reg.md
rename api docs to internals
2018-03-26 11:43:37 -07:00
internals_midi_device.md
rename api docs to internals
2018-03-26 11:43:37 -07:00
internals_midi_device_setup_process.md
rename api docs to internals
2018-03-26 11:43:37 -07:00
internals_midi_util.md
rename api docs to internals
2018-03-26 11:43:37 -07:00
internals_send_functions.md
rename api docs to internals
2018-03-26 11:43:37 -07:00
internals_sysex_tools.md
rename api docs to internals
2018-03-26 11:43:37 -07:00
isp_flashing_guide.md
[Docs] Update ISP Flashing guide ( #8149 )
2020-03-01 22:29:26 -08:00
keycodes.md
remove some unnecessary external links
2020-03-05 16:00:10 -08:00
keycodes_basic.md
Remove obsolete note about media keys in MacOS ( #6631 )
2019-10-30 10:39:38 +11:00
keycodes_us_ansi_shifted.md
Backslash-escape pipe character in keycode lists ( #7157 )
2019-10-26 06:10:03 +01:00
keymap.md
[Docs] Smallish overhaul of the docs ( #5281 )
2019-03-18 14:22:02 -07:00
mod_tap.md
break feature_advanced_keycodes.md up into multiple files
2020-03-05 16:00:10 -08:00
newbs.md
overhaul the newbs guide
2020-03-05 16:00:10 -08:00
newbs_building_firmware.md
overhaul the newbs guide
2020-03-05 16:00:10 -08:00
newbs_building_firmware_configurator.md
Polish Configurator section
2020-03-05 16:00:10 -08:00
newbs_flashing.md
overhaul the newbs guide
2020-03-05 16:00:10 -08:00
newbs_getting_started.md
fix numbering
2020-03-05 16:00:10 -08:00
newbs_git_best_practices.md
[Docs] Restructure of Git Best Practices doc ( #7231 )
2019-12-02 18:47:02 -08:00
newbs_git_resolving_merge_conflicts.md
[Docs] Restructure of Git Best Practices doc ( #7231 )
2019-12-02 18:47:02 -08:00
newbs_git_resynchronize_a_branch.md
[Docs] Fix minor differences in docs/newbs_git_resynchronize_a_branch.md ( #7728 )
2019-12-27 14:31:23 -08:00
newbs_git_using_your_master_branch.md
[Docs] Restructure of Git Best Practices doc ( #7231 )
2019-12-02 18:47:02 -08:00
newbs_learn_more_resources.md
overhaul the newbs guide
2020-03-05 16:00:10 -08:00
newbs_testing_debugging.md
overhaul the newbs guide
2020-03-05 16:00:10 -08:00
one_shot_keys.md
break feature_advanced_keycodes.md up into multiple files
2020-03-05 16:00:10 -08:00
other_eclipse.md
[Docs] Add VSCode guide to docs ( #5124 )
2019-03-15 14:34:58 -07:00
other_vscode.md
[Docs] Add VSCode guide to docs ( #5124 )
2019-03-15 14:34:58 -07:00
power.txt
Trim trailing whitespace
2017-12-09 10:46:11 -05:00
proton_c_conversion.md
Update feature support for Proton C ( #7596 )
2019-12-10 18:31:39 -05:00
qmk.css
Some more tweaks to make everything look nice
2018-05-07 23:42:41 -07:00
quantum_keycodes.md
Move Grave Escape, Lock and Leader keycodes into their own sect… ( #8093 )
2020-02-07 15:54:14 +11:00
README.md
Rework the newbs guide around the qmk cli
2020-03-05 16:00:10 -08:00
redirects.json
Configuration system for CLI ( #6708 )
2019-09-22 13:25:33 -07:00
ref_functions.md
Additional changes for Layer State typedef compatibility ( #5906 )
2019-08-21 17:07:49 -07:00
reference_configurator_support.md
Polish Configurator section
2020-03-05 16:00:10 -08:00
reference_glossary.md
Remove apostrophe from various abbreviations' plural forms ( #7050 )
2019-10-22 13:47:43 +01:00
reference_info_json.md
Add label to the info.json reference
2019-02-08 15:13:20 -08:00
sidebar.css
CSS updates: ul and pre elements
2020-03-05 16:00:10 -08:00
support.md
remove some unnecessary external links
2020-03-05 16:00:10 -08:00
sw.js
Fix up info boxes.
2018-05-07 22:46:26 -07:00
tap_hold.md
break feature_advanced_keycodes.md up into multiple files
2020-03-05 16:00:10 -08:00
translating.md
Add yet another dictionary for the QMK Firmware docs sidebar heading ( #7504 )
2019-11-28 22:14:04 +00:00
understanding_qmk.md
Remove apostrophe from various abbreviations' plural forms ( #7050 )
2019-10-22 13:47:43 +01:00
unit_testing.md
Trim trailing whitespace
2017-12-09 10:46:11 -05:00
usb_nkro.txt
convert docs to lowercase and underscores
2017-06-10 14:58:55 -04:00
ws2812_driver.md
PWM DMA based RGB Underglow for STM32 ( #7928 )
2020-03-01 13:05:56 +11:00
