qmk/docs
Joel Challis 6f93a86e6e
Add LED/RGB Matrix flags API docs (#25673)
2025-09-29 20:27:07 +01:00
..
ChangeLog
drivers
features
public
__capabilities.md
__capabilities_inc.md Add embed to docs capabilities (#23698) 2024-05-12 03:26:11 +10:00
_aliases.json
_sidebar.json
api_development_environment.md
api_development_overview.md
api_docs.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
api_overview.md
arm_debugging.md [Docs] fix docs (#7642) 2019-12-21 11:00:22 +00:00
breaking_changes.md
breaking_changes_history.md
breaking_changes_instructions.md
chibios_upgrade_instructions.md Update branch names to reflect configurator's new deployment. (#19999) 2023-03-03 14:16:06 +11:00
cli.md
cli_commands.md Print build failures with `qmk mass-compile` and `qmk userspace-compile` if requested (`-p`/`--print-failures`) (#25518) 2025-09-09 17:35:01 +01:00
cli_configuration.md
cli_development.md
cli_tab_complete.md [docs] Fix code blocks overflowing page width (#23829) 2024-05-30 10:00:28 +01:00
coding_conventions_c.md [Docs] Code markdown amendment (#21323) 2023-06-20 20:58:13 -06:00
coding_conventions_python.md
compatible_microcontrollers.md
config_options.md Remove `DEFAULT_FOLDER` handling (#23281) 2025-06-09 05:08:56 +01:00
configurator_architecture.md
configurator_default_keymaps.md
configurator_diagram.drawio
configurator_diagram.svg
configurator_step_by_step.md
configurator_troubleshooting.md
contributing.md
custom_matrix.md
custom_quantum_functions.md
data_driven_config.md
documentation_best_practices.md
documentation_templates.md
driver_installation_zadig.md Added MCU support for ArteryTek AT32F415 (#23445) 2024-11-21 17:28:28 +11:00
easy_maker.md
faq_build.md
faq_debug.md
faq_general.md Correct link in faq_general.md (#25640) 2025-09-09 19:43:28 -06:00
faq_keymap.md
faq_misc.md
feature_advanced_keycodes.md
feature_converters.md
feature_debounce_type.md docs: fix misspellings (#25555) 2025-09-09 14:51:13 -07:00
feature_eeprom.md
feature_layers.md
feature_layouts.md
feature_macros.md
feature_userspace.md docs: fix misspellings (#25555) 2025-09-09 14:51:13 -07:00
flashing.md
fuse.txt Ensure single newline at EOF for core files (#11310) 2020-12-28 04:36:32 +11:00
getting_started_docker.md Allow running Docker container on MacOS (without in-container USB support) (#24412) 2025-01-16 06:36:20 +11:00
getting_started_github.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
getting_started_introduction.md
getting_started_make_guide.md [docs] Align more keyboard placeholders (#25510) 2025-07-23 13:08:48 +01:00
hand_wire.md
hardware_drivers.md
hardware_keyboard_guidelines.md
how_a_matrix_works.md
how_keyboards_work.md
index.md
isp_flashing_guide.md
keycodes.md
keycodes_basic.md
keycodes_magic.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
keycodes_us_ansi_shifted.md
keymap.md
license_violations.md
mod_tap.md Deprecate some nonstandard mod & mod-tap keycode aliases (#25437) 2025-07-06 20:30:47 +10:00
newbs.md
newbs_building_firmware.md
newbs_building_firmware_configurator.md
newbs_building_firmware_workflow.md
newbs_external_userspace.md
newbs_flashing.md
newbs_getting_started.md
newbs_git_best_practices.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
newbs_git_resolving_merge_conflicts.md
newbs_git_resynchronize_a_branch.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
newbs_git_using_your_master_branch.md
newbs_learn_more_resources.md
newbs_testing_debugging.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
one_shot_keys.md
other_eclipse.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
other_vscode.md
platformdev_blackpill_f4x1.md Docs: typo fixes in platformdev_blackpill_f4x1.md (#19635) 2023-01-19 16:09:11 -07:00
platformdev_chibios_earlyinit.md
platformdev_proton_c.md
platformdev_rp2040.md
platformdev_selecting_arm_mcu.md
porting_your_keyboard_to_qmk.md Correct link in porting_your_keyboard_to_qmk.md (#25635) 2025-09-09 19:44:47 -06:00
power.txt
pr_checklist.md
proprietary_libs.md
quantum_keycodes.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
quantum_painter.md
quantum_painter_lvgl.md docs: fix misspellings (#25555) 2025-09-09 14:51:13 -07:00
quantum_painter_qff.md
quantum_painter_qgf.md Add `compiler_support.h` (#25274) 2025-05-22 23:31:15 +10:00
quantum_painter_rle.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
ref_functions.md Add easier way to set default single layer (#24376) 2024-10-06 21:39:21 +13:00
reference_configurator_support.md Fix rendering of `reference_configurator_support.md` (#24629) 2024-11-21 18:46:36 +00:00
reference_glossary.md
reference_info_json.md
reference_keymap_extras.md
squeezing_avr.md
support.md
support_deprecation_policy.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
syllabus.md
tap_hold.md
understanding_qmk.md
unit_testing.md
usb_nkro.txt