qmk_firmware

ChangeLog

Stub out changelog

2026-06-01 02:21:55 +01:00

drivers

Fix small typo in WS2812 driver doc (#25928 )

2026-01-03 20:18:41 +00:00

features

[Docs] Tap-hold doc improvements and suggest an HRMs starter recipe (#26284 )

2026-07-03 11:48:28 +08:00

public

[CI] Format code according to conventions (#26000 )

2026-02-11 16:06:13 +00:00

__capabilities_inc.md

Add embed to docs capabilities (#23698 )

2024-05-12 03:26:11 +10:00

__capabilities.md

[docs] Remove gitbook directory (#23839 )

2024-06-01 10:37:40 +10:00

_aliases.json

Revert removal of QK_OUTPUT_AUTO, fixup docs to reflect. (#24593 )

2024-11-14 21:16:52 +11:00

_sidebar.json

Stub out changelog

2026-06-01 02:21:55 +01:00

api_development_environment.md

Add API documentation

2020-03-05 16:00:10 -08:00

api_development_overview.md

Fix typo in docs/api_development_overview.md (#24620 )

2024-11-19 13:37:39 -07:00

api_docs.md

Vitepress conversion of docs. (#23795 )

2024-05-30 12:00:41 +10:00

api_overview.md

Vitepress conversion of docs. (#23795 )

2024-05-30 12:00:41 +10:00

arm_debugging.md

[Docs] fix docs (#7642 )

2019-12-21 11:00:22 +00:00

breaking_changes_history.md

Stub out changelog

2026-06-01 02:21:55 +01:00

breaking_changes_instructions.md

Update Discord URL (#24283 )

2024-08-15 14:37:27 +01:00

breaking_changes.md

Stub out changelog

2026-06-01 02:21:55 +01:00

chibios_upgrade_instructions.md

Update branch names to reflect configurator's new deployment. (#19999 )

2023-03-03 14:16:06 +11:00

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

[docs] Fix code blocks overflowing page width (#23829 )

2024-05-30 10:00:28 +01:00

cli_development.md

Deploy qmk_udev during bootstrap, updated CLI bootstrap docs (#26147 )

2026-04-14 11:02:31 +01:00

cli_tab_complete.md

[docs] Fix code blocks overflowing page width (#23829 )

2024-05-30 10:00:28 +01:00

cli.md

Deploy qmk_udev during bootstrap, updated CLI bootstrap docs (#26147 )

2026-04-14 11:02:31 +01:00

coding_conventions_c.md

[Docs] Code markdown amendment (#21323 )

2023-06-20 20:58:13 -06:00

coding_conventions_python.md

Align to latest CLI dependencies (#24553 )

2025-03-20 14:04:10 +11:00

compatible_microcontrollers.md

Added MCU support for ArteryTek AT32F415 (#23445 )

2024-11-21 17:28:28 +11:00

config_options.md

Remove deprecated audio pin defines (#26111 )

2026-03-28 07:29:27 +00:00

configurator_architecture.md

Architecture documentation for Configurator and API (#13935 )

2021-08-10 07:47:53 -07:00

configurator_default_keymaps.md

Update leftover RGB keycodes (#24653 )

2024-11-30 05:30:05 +00:00

configurator_diagram.drawio

Add EOL to non-keyboard files (#24990 )

2025-03-06 23:17:51 +00:00

configurator_diagram.svg

Add EOL to non-keyboard files (#24990 )

2025-03-06 23:17:51 +00:00

configurator_step_by_step.md

Remove suggestion of creating issues for unsupported keyboards. (#23918 )

2024-06-14 00:23:57 +01:00

configurator_troubleshooting.md

Vitepress conversion of docs. (#23795 )

2024-05-30 12:00:41 +10:00

contributing.md

qmk docs: restore --port and --browser arguments (#24623 )

2025-02-01 21:19:30 +11:00

custom_matrix.md

Debounce: Deprecate num_rows parameter (#25632 )

2025-10-19 03:14:37 +01:00

custom_quantum_functions.md

docs: fix misspellings (#25555 )

2025-09-09 14:51:13 -07:00

data_driven_config.md

Update data_driven_config.md (#25612 )

2025-09-10 01:52:25 -07:00

documentation_best_practices.md

QMK avoids raw line breaks within paragraphs in Markdown (#26080 )

2026-03-19 10:16:35 +08:00

documentation_templates.md

Vitepress conversion of docs. (#23795 )

2024-05-30 12:00:41 +10:00

driver_installation_zadig.md

QMK CLI Environment bootstrapper (#25038 )

2025-11-28 00:36:49 +11:00

easy_maker.md

[docs] Replace Imgur-hosted images (#25690 )

2025-11-04 00:05:39 +00:00

faq_build.md

Deploy qmk_udev during bootstrap, updated CLI bootstrap docs (#26147 )

2026-04-14 11:02:31 +01:00

faq_debug.md

[Core] get_keycode_string(): function to format keycodes as strings, for more readable debug logging. (#24787 )

2025-03-19 20:45:56 +01:00

faq_general.md

Correct link in faq_general.md (#25640 )

2025-09-09 19:43:28 -06:00

faq_keymap.md

[docs] Replace Imgur-hosted images (#25690 )

2025-11-04 00:05:39 +00:00

faq_misc.md

Vitepress conversion of docs. (#23795 )

2024-05-30 12:00:41 +10:00

feature_advanced_keycodes.md

Deprecate some nonstandard mod & mod-tap keycode aliases (#25437 )

2025-07-06 20:30:47 +10:00

feature_converters.md

Rework converter docs (#18314 )

2025-11-06 18:36:07 +00:00

feature_debounce_type.md

docs: fix misspellings (#25555 )

2025-09-09 14:51:13 -07:00

feature_eeprom.md

Add EECONFIG_{KB,USER}_DATA_SIZE docs (#26200 )

2026-05-19 02:58:50 +01:00

feature_layers.md

[Docs] Tap-hold doc improvements and suggest an HRMs starter recipe (#26284 )

2026-07-03 11:48:28 +08:00

feature_layouts.md

[docs] Fix code blocks overflowing page width (#23829 )

2024-05-30 10:00:28 +01:00

feature_macros.md

Convert stray legacy warn/info docs panels (#24799 )

2025-01-07 19:12:54 -08:00

feature_userspace.md

docs: fix misspellings (#25555 )

2025-09-09 14:51:13 -07:00

flashing.md

Deploy qmk_udev during bootstrap, updated CLI bootstrap docs (#26147 )

2026-04-14 11:02:31 +01:00

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

[docs] Replace Imgur-hosted images (#25690 )

2025-11-04 00:05:39 +00:00

getting_started_introduction.md

[docs] Align more keyboard placeholders (#25510 )

2025-07-23 13:08:48 +01:00

getting_started_make_guide.md

Remove FORCE_NKRO (#26206 )

2026-05-16 02:27:19 +01:00

hand_wire.md

[docs] Replace Imgur-hosted images (#25690 )

2025-11-04 00:05:39 +00:00

hardware_drivers.md

docs: fix misspellings (#25555 )

2025-09-09 14:51:13 -07:00

hardware_keyboard_guidelines.md

[docs] Align more keyboard placeholders (#25510 )

2025-07-23 13:08:48 +01:00

how_a_matrix_works.md

[docs] Fix code blocks overflowing page width (#23829 )

2024-05-30 10:00:28 +01:00

how_keyboards_work.md

Vitepress conversion of docs. (#23795 )

2024-05-30 12:00:41 +10:00

index.md

Update Discord URL (#24283 )

2024-08-15 14:37:27 +01:00

isp_flashing_guide.md

Update USBaspLoader ISP instructions (#25590 )

2025-09-07 13:05:34 +01:00

keycodes_basic.md

[DOCS] Fix keycodes_basic FastForward + Rewind #25685 (#25686 )

2025-09-29 23:54:48 +01:00

keycodes_magic.md

Vitepress conversion of docs. (#23795 )

2024-05-30 12:00:41 +10:00

keycodes_us_ansi_shifted.md

[Docs] Address some typos (also in moonlander matrix.c) (#16248 )

2022-02-06 17:36:44 +00:00

keycodes.md

Merge remote-tracking branch 'origin/master' into develop

2025-09-29 22:55:23 +00:00

keymap.md

[docs] Fix code blocks overflowing page width (#23829 )

2024-05-30 10:00:28 +01:00

license_violations.md

License violations updates. (#26076 )

2026-03-16 03:12:18 +00:00

mod_tap.md

[Docs] Tap-hold doc improvements and suggest an HRMs starter recipe (#26284 )

2026-07-03 11:48:28 +08:00

newbs_building_firmware_configurator.md

[docs] Replace Imgur-hosted images (#25690 )

2025-11-04 00:05:39 +00:00

newbs_building_firmware_workflow.md

Docs theme updates (#23832 )

2024-05-31 10:34:30 +10:00

newbs_building_firmware.md

[docs] Align keyboard and keymap placeholders (#25509 )

2025-07-23 04:33:37 +01:00

newbs_external_userspace.md

[docs] Replace Imgur-hosted images (#25690 )

2025-11-04 00:05:39 +00:00

newbs_flashing.md

[docs] Align keyboard and keymap placeholders (#25509 )

2025-07-23 04:33:37 +01:00

newbs_getting_started.md

Additional bootstrapper safety checks (#26242 )

2026-06-01 09:07:29 +01:00

newbs_git_best_practices.md

Vitepress conversion of docs. (#23795 )

2024-05-30 12:00:41 +10:00

newbs_git_resolving_merge_conflicts.md

Vitepress conversion of docs. (#23795 )

2024-05-30 12:00:41 +10:00

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

Vitepress conversion of docs. (#23795 )

2024-05-30 12:00:41 +10:00

newbs_learn_more_resources.md

[Docs] Refactor code examples (#18003 )

2022-08-12 17:27:24 -07:00

newbs_testing_debugging.md

Vitepress conversion of docs. (#23795 )

2024-05-30 12:00:41 +10:00

newbs.md

[docs] Fix dead link to keyboard list in newbs.md (#24579 )

2024-11-09 09:49:11 -07:00

one_shot_keys.md

Add short aliases for OSM() (#25443 )

2025-07-06 16:57:51 +10:00

other_eclipse.md

[docs] Replace Imgur-hosted images (#25690 )

2025-11-04 00:05:39 +00:00

other_vscode.md

[docs] Replace Imgur-hosted images (#25690 )

2025-11-04 00:05:39 +00:00

platformdev_blackpill_f4x1.md

[docs] Replace Imgur-hosted images (#25690 )

2025-11-04 00:05:39 +00:00

platformdev_chibios_earlyinit.md

Vitepress conversion of docs. (#23795 )

2024-05-30 12:00:41 +10:00

platformdev_proton_c.md

[docs] Replace Imgur-hosted images (#25690 )

2025-11-04 00:05:39 +00:00

platformdev_rp2040.md

[docs] Replace Imgur-hosted images (#25690 )

2025-11-04 00:05:39 +00:00

platformdev_selecting_arm_mcu.md

Vitepress conversion of docs. (#23795 )

2024-05-30 12:00:41 +10:00

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

Trim trailing whitespace

2017-12-09 10:46:11 -05:00

pr_checklist.md

Update PR checklist notes on custom matrix (#25240 )

2025-05-18 16:42:43 +01:00

proprietary_libs.md

Add proprietary libraries policy page. (#25532 )

2025-08-01 23:26:30 +10:00

quantum_keycodes.md

Vitepress conversion of docs. (#23795 )

2024-05-30 12:00:41 +10:00

quantum_painter_lvgl.md

docs: fix misspellings (#25555 )

2025-09-09 14:51:13 -07:00

quantum_painter_qff.md

Add compiler_support.h (#25274 )

2025-05-22 23:31:15 +10:00

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

quantum_painter.md

[QP] Minor cleanup and support for RGB888 surface (#25706 )

2025-10-07 19:10:38 -07: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

[docs] Replace Imgur-hosted images (#25690 )

2025-11-04 00:05:39 +00:00

reference_glossary.md

[docs] Organize driver & feature docs into subfolders (#23848 )

2024-06-02 12:42:24 +10:00

reference_info_json.md

[DOCS] Add keycodes to info.json docs. More precise matrix masking info (#25801 )

2025-12-04 12:15:43 +00:00

reference_keymap_extras.md

Add keymap-extras for EurKEY layout (#24241 )

2024-12-23 23:23:51 -08:00

squeezing_avr.md

Guard remapping logic with MAGIC_ENABLE (#25537 )

2025-11-06 23:03:28 +00:00

support_deprecation_policy.md

Vitepress conversion of docs. (#23795 )

2024-05-30 12:00:41 +10:00

support.md

Update Discord URL (#24283 )

2024-08-15 14:37:27 +01:00

syllabus.md

[Docs] Remove references to bootmagic lite (#24369 )

2024-09-06 17:30:54 +01:00

tap_hold.md

[Docs] Tap-hold doc improvements and suggest an HRMs starter recipe (#26284 )

2026-07-03 11:48:28 +08:00

understanding_qmk.md

Deprecate LAYOUT() macro in favor of JSON matrix definitions

2025-11-04 15:06:56 +08:00

unit_testing.md

[Core] get_keycode_string(): function to format keycodes as strings, for more readable debug logging. (#24787 )

2025-03-19 20:45:56 +01:00

usb_nkro.txt

docs: fix misspellings (#25555 )

2025-09-09 14:51:13 -07:00