summaryrefslogtreecommitdiff
path: root/docs/faq_keymap.md
AgeCommit message (Collapse)AuthorFilesLines
2025-11-04[docs] Replace Imgur-hosted images (#25690)James Young1-1/+1
2024-09-06[Docs] Remove references to bootmagic lite (#24369)jack1-1/+1
2024-06-02[docs] Organize driver & feature docs into subfolders (#23848)Ryan1-3/+3
Co-authored-by: Nick Brassel <nick@tzarc.org>
2024-05-30Vitepress conversion of docs. (#23795)Nick Brassel1-6/+6
2022-05-18Keymap FAQ updates (#17130)Ryan1-38/+33
2021-11-03Basic keycode overhaul (#14726)Ryan1-6/+6
2021-09-01[Docs] Update path to keycode.h (#14263)qieq1-1/+1
2021-08-06Remove Full Bootmagic (#13846)James Young1-1/+1
* disambiguate Bootmagic rules in keymaps The files edited by this commit were added at a point in time where `BOOTMAGIC_ENABLE = yes` enabled full Bootmagic. This commit edits the files to specify that full Bootmagic is intended. * remove BOOTMAGIC_ENABLE=full setting * unify commented BOOTMAGIC_ENABLE rules in keyboards Explicitly sets `BOOTMAGIC_ENABLE = no` in keyboards where the rule was commented out. Command: ``` find keyboards/ -type f -name 'rules.mk' -and -not -path '*/keymaps/*' -exec sed -i -e 's;#[ \t]*\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-zA-Z]\+\).*;\1 = no # Virtual DIP switch configuration;g' {} + ``` * remove commented Bootmagic rules from keymap/user level Command: ``` find keyboards/ layouts/ users/ -type f -name 'rules.mk' -exec sed -i -e '/#.*\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).*/d' {} + ``` * update keyboard BOOTMAGIC_ENABLE rule formatting Sets the formatting of BOOTMAGIC_ENABLE rules to `BOOTMAGIC_ENABLE = [value]`, without the inline comments (which will be replaced later). Command: ``` find keyboards/ -type f -name 'rules.mk' -and -not -path '*/keymaps/*' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).*;\1 = \2;g' '{}' + ``` * update keyboards' BOOTMAGIC_ENABLE settings Updates keyboard `rules.mk` files to use `BOOTMAGIC_ENABLE = lite` where `BOOTMAGIC_ENABLE = full` was being used. Command: ``` find keyboards/ -type f -name 'rules.mk' -and -not -path '*/keymaps/*' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = \)full;\1lite;g' '{}' + ``` * update keymap/user BOOTMAGIC_ENABLE settings Updates keymap/user `rules.mk` files to use `BOOTMAGIC_ENABLE = lite` where `BOOTMAGIC_ENABLE = full` was being used. Commands: ``` find keyboards/ -type f -name 'rules.mk' -and -path '*/keymaps/*' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE[ \t=]\+\)full;\1lite;g' '{}' + find layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE[ \t=]\+\)full;\1lite;g' '{}' + ``` * remove and replace inline comments in keyboards and keymap/user files Removes and replaces the inline comments, which have been updated to read `Enable Bootmagic Lite`. Commands: ``` find keyboards/ -type f -name 'rules.mk' -and -path '*/keymaps/*' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).*;\1 = \2;g' '{}' + find layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).*;\1 = \2;g' '{}' + find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = lite\);\1 # Enable Bootmagic Lite;g' '{}' + find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = yes\);\1 # Enable Bootmagic Lite;g' '{}' + find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = no\);\1 # Enable Bootmagic Lite;g' '{}' + ``` * rename improperly named makefiles Some files intended to be used as makefiles had improper names causing them to not be used as intended when building. This commit corrects the filenames of the affected files. * update renamed file with new rule formatting * update QMK's template files Updates QMK's `rules.mk` templates to use the new inline comment. * update QMK Docs - remove documentation of full Bootmagic - update links to Bootmagic Lite doc - add doc for Magic Keycodes * rules.mk patch for coarse/ixora and coarse/vinta
2021-01-30[Docs] Use HTTPS for images and links where possible (#11695)Ryan1-5/+5
2020-03-05make custom_keycode_names.md a faq entry insteadskullY1-0/+11
2019-12-11[Docs] Remove some outdated FAQ items (#7607)fauxpark1-62/+1
2019-10-30Remove obsolete note about media keys in MacOS (#6631)Steve Purcell1-7/+0
* Remove obsolete note about media keys in MacOS KC_MNXT and KC_MPRV work fine on MacOS, so this note is obsolete. * Document behaviour of MEDIA_FAST_FORWARD/MEDIA_REWIND codes on MacOS * Small typo fix, and make OS-dependent keycode claim less absolute * Update docs/keycodes_basic.md Co-Authored-By: fauxpark <fauxpark@gmail.com>
2019-02-21Replace instances of KEYMAP with LAYOUTnoroadsleft1-2/+2
Many instances in the QMK Docs referenced KEYMAP macros, which is outdated terminology. Replaced most instances of KEYMAP with LAYOUT, to reflect the desired usage.
2018-12-01Add tap_random_base64 and software timer info to Useful Functions doc (#4360)Drashna Jaelre1-17/+0
* Update docs * Add security caveat Co-Authored-By: drashna <drashna@live.com> * Wordsmithing Co-Authored-By: drashna <drashna@live.com> * Update docs/ref_functions.md Co-Authored-By: drashna <drashna@live.com>
2018-11-25Keymap FAQ: fix positions of KC_HENK and KC_MHEN for JIS layout (#4482)noroadsleft1-2/+2
These keys were previously in each other's positions.
2018-08-15Docs: Update image in FAQ/Keymap: KC_EQLS -> KC_EQL (#3660)zgtm1-2/+2
2018-08-11Update FAQ section on power keysfauxpark1-5/+4
2018-08-05Update FAQ section on Apple Fn (#3574)fauxpark1-5/+5
2018-03-02More thoroughly document Bootmagic and Command (#2455)skullydazed1-12/+21
2018-01-01backlight breathing overhaul (#2187)Balz Guenat1-1/+1
* add breathing to bananasplit * backlight breathing overhaul * fix the backlight_tick thing. * fix for vision_division backlight * fix a few keymaps and probably break breathing for some weirdly set-up boards. * remove BL_x keycodes because they made unreasonable assumptions * some fixes for BL keycodes * integer cie lightness scaling * use cie lightness for non-breathing backlight and make breathing able to reach true max brightness
2017-12-09Trim trailing whitespacefauxpark1-2/+2
2017-12-09Fix some of the more obvious typosfauxpark1-5/+5
2017-12-09Convert all headings to Title Casefauxpark1-16/+16
2017-12-03Flesh out the grave escape overridesskullY1-4/+2
2017-10-24Restructure the hardware and feature docs to make things easier to find (#1888)skullydazed1-0/+11
* fix #1313 by documenting more config.h options * Clean up and organize documentation
2017-08-16Doc updates from going through every fileskullY1-2/+2
2017-08-16Overhaul the Getting Started section and add a FAQ sectionskullY1-1/+1
2017-08-11fix code block formattingBalz Guenat1-1/+1
2017-08-11add description of new option to docs and add option (commented out) into ↵Balz Guenat1-1/+3
template.
2017-07-03Update a bunch of docsskullY1-74/+20
2017-06-10convert docs to lowercase and underscoresJack Humbert1-0/+265
generated by cgit v1.2.3 (git 2.25.1) at 2026-09-03 06:54:41 +0000