docs · qmk_firmware · Tangled

keyboard stuff

qmk_firmware docs

4 folders · 113 files

Jacek Królikowski · [DOCS] Add `keycodes` to `info.json` docs. More precise matrix masking info (#25801) · 11mo ago

2025q4 develop changelog (#25845)

Add I2C Transmit and Receive function (#25637)

Simplify docs for Key Overrides config (#25787)

Rework converter docs (#18314)

__capabilities_inc.md

Add embed to docs capabilities (#23698)

__capabilities.md

[docs] Remove gitbook directory (#23839)

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

2025q4 develop changelog (#25845)

api_development_environment.md

api_development_overview.md

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

Vitepress conversion of docs. (#23795)

api_overview.md

Vitepress conversion of docs. (#23795)

arm_debugging.md

breaking_changes_history.md

2025q4 develop changelog (#25845)

breaking_changes_instructions.md

Update Discord URL (#24283)

breaking_changes.md

2025q4 develop changelog (#25845)

chibios_upgrade_instructions.md

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

cli_commands.md

Print build failures with `qmk mass-compile` and `qmk userspace-compile` if requested (`-p`/`--print-failures`) (#25518)

cli_configuration.md

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

cli_development.md

Align to latest CLI dependencies (#24553)

cli_tab_complete.md

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

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

coding_conventions_c.md

[Docs] Code markdown amendment (#21323)

coding_conventions_python.md

Align to latest CLI dependencies (#24553)

compatible_microcontrollers.md

Added MCU support for ArteryTek AT32F415 (#23445)

config_options.md

Remove `DEFAULT_FOLDER` handling (#23281)

configurator_architecture.md

Architecture documentation for Configurator and API (#13935)

configurator_default_keymaps.md

Update leftover RGB keycodes (#24653)

configurator_diagram.drawio

Add EOL to non-keyboard files (#24990)

configurator_diagram.svg

Add EOL to non-keyboard files (#24990)

configurator_step_by_step.md

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

configurator_troubleshooting.md

Vitepress conversion of docs. (#23795)

contributing.md

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

custom_matrix.md

Debounce: Deprecate num_rows parameter (#25632)

custom_quantum_functions.md

docs: fix misspellings (#25555)

data_driven_config.md

Update data_driven_config.md (#25612)

documentation_best_practices.md

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

documentation_templates.md

Vitepress conversion of docs. (#23795)

driver_installation_zadig.md

QMK CLI Environment bootstrapper (#25038)

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

QMK CLI Environment bootstrapper (#25038)

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

Correct link in faq_general.md (#25640)

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

Vitepress conversion of docs. (#23795)

feature_advanced_keycodes.md

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

feature_converters.md

Rework converter docs (#18314)

feature_debounce_type.md

docs: fix misspellings (#25555)

feature_eeprom.md

docs: fix misspellings (#25555)

feature_layers.md

docs: fix misspellings (#25555)

feature_layouts.md

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

feature_macros.md

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

feature_userspace.md

docs: fix misspellings (#25555)

Added MCU support for ArteryTek AT32F415 (#23445)

Ensure single newline at EOF for core files (#11310)

getting_started_docker.md

Allow running Docker container on MacOS (without in-container USB support) (#24412)

getting_started_github.md

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

getting_started_introduction.md

[docs] Align more keyboard placeholders (#25510)

getting_started_make_guide.md

[docs] Align more keyboard placeholders (#25510)

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

hardware_drivers.md

docs: fix misspellings (#25555)

hardware_keyboard_guidelines.md

[docs] Align more keyboard placeholders (#25510)

how_a_matrix_works.md

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

how_keyboards_work.md

Vitepress conversion of docs. (#23795)

Update Discord URL (#24283)

isp_flashing_guide.md

Update USBaspLoader ISP instructions (#25590)

keycodes_basic.md

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

keycodes_magic.md

Vitepress conversion of docs. (#23795)

keycodes_us_ansi_shifted.md

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

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

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

license_violations.md

More Yunzii notes regarding refusal to provide sources. (#25335)

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

newbs_building_firmware_configurator.md

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

newbs_building_firmware_workflow.md

Docs theme updates (#23832)

newbs_building_firmware.md

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

newbs_external_userspace.md

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

newbs_flashing.md

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

newbs_getting_started.md

QMK CLI Environment bootstrapper (#25038)

newbs_git_best_practices.md

Vitepress conversion of docs. (#23795)

newbs_git_resolving_merge_conflicts.md

Vitepress conversion of docs. (#23795)

newbs_git_resynchronize_a_branch.md

Vitepress conversion of docs. (#23795)

newbs_git_using_your_master_branch.md

Vitepress conversion of docs. (#23795)

newbs_learn_more_resources.md

[Docs] Refactor code examples (#18003)

newbs_testing_debugging.md

Vitepress conversion of docs. (#23795)

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

one_shot_keys.md

Add short aliases for `OSM()` (#25443)

other_eclipse.md

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

other_vscode.md

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

platformdev_blackpill_f4x1.md

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

platformdev_chibios_earlyinit.md

Vitepress conversion of docs. (#23795)

platformdev_proton_c.md

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

platformdev_rp2040.md

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

platformdev_selecting_arm_mcu.md

Vitepress conversion of docs. (#23795)

porting_your_keyboard_to_qmk.md

Correct link in porting_your_keyboard_to_qmk.md (#25635)

pr_checklist.md

Update PR checklist notes on custom matrix (#25240)

proprietary_libs.md

Add proprietary libraries policy page. (#25532)

quantum_keycodes.md

Vitepress conversion of docs. (#23795)

quantum_painter_lvgl.md

docs: fix misspellings (#25555)

quantum_painter_qff.md

Add `compiler_support.h` (#25274)

quantum_painter_qgf.md

Add `compiler_support.h` (#25274)

quantum_painter_rle.md

Vitepress conversion of docs. (#23795)

quantum_painter.md

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

ref_functions.md

Add easier way to set default single layer (#24376)

reference_configurator_support.md

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

reference_glossary.md

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

reference_info_json.md

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

reference_keymap_extras.md

Add keymap-extras for EurKEY layout (#24241)

squeezing_avr.md

Guard remapping logic with MAGIC_ENABLE (#25537)

support_deprecation_policy.md

Vitepress conversion of docs. (#23795)

Update Discord URL (#24283)

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

[Core] Speculative Hold option for mod-taps: hold mods instantly while unsettled. (#25572)

understanding_qmk.md

Deprecate LAYOUT() macro in favor of JSON matrix definitions

unit_testing.md

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

docs: fix misspellings (#25555)