summaryrefslogtreecommitdiff
path: root/docs/understanding_qmk.md
AgeCommit message (Collapse)AuthorFilesLines
2025-11-04Deprecate LAYOUT() macro in favor of JSON matrix definitionsAndrew C1-2/+2
* Indicate <keyboard>.h LAYOUT() deprecation in understanding_qmk.md Initial documentation uses <keyboard>.json to define matrix pin definitions, rather than having users #define the LAYOUT() macro in <keyboard>.h - This change brings this docs inline with the [porting_guidelines](https://docs.qmk.fm/porting_your_keyboard_to_qmk), QMK MSYS will also throw an error if this is attempted. * Update understanding_qmk.md enclosed '<' using backtick * style guideline, now builds correctly prior version indicates directory, new indicates config. still the same idea.
2024-05-30Vitepress conversion of docs. (#23795)Nick Brassel1-3/+3
2023-05-20Move `pre_process_record_kb()` before `process_combo()` (#20969)Sergey Vlasov1-1/+1
2023-05-13Add a user callback for pre process record (#20584)Albert Y1-0/+2
2023-01-24Update understanding_qmk.md (#19664)arrowj1-1/+1
Changed "...4 row by 5 column numpad" to "...5 row by 4 column numpad" on line 46.
2022-11-06Remove thermal printer. (#18959)Nick Brassel1-1/+0
2022-09-03[Docs] Update 'Process Record' according to the code (#18209)coliss861-30/+43
* [doc] Update 'Process Record' according to the code * [doc] fix link
2022-05-30Removes terminal from QMK. (#17258)Nick Brassel1-1/+0
2022-03-05Some docs improvements (#15845)kiilerix1-10/+5
* docs: clarify in "Keymap Overview" what LAYOUT is and isn't It is not strictly necessary to use LAYOUT macros in keyboard.c, but it is a convenient abstraction of hardware internals, allowing focus on the physical keyboard layout. From the C source point of view LAYOUT is macro with a parameter list, which expands to a array of rows that each is an array with a keyboard scancode for each column. A macro parameter list is not an array, and even less a single array. Perhaps no big deal, but also no reason to give incorrect hints. * docs: update "Understanding QMK's Code" to current code structure introduced in 96e2b13d1de This part of the documentation was no longer correct. I tried updating it, mainly copy editing and using github links to latest release. This is not trying to fix all problems, but just trying to fix some problems while reusing much of the old phrases and structure. * Update docs to use "qmk format-python"
2021-11-30[Docs] Reorder functions in Understanding QMK (#15357)thesecretmaster1-28/+30
2021-11-26New feature: `DYNAMIC_TAPPING_TERM_ENABLE` (#11036)precondition1-0/+1
* New feature: `DYNAMIC_TAPPING_TERM_ENABLE` 3 new quantum keys to configure the tapping term on the fly. * Replace sprintf call in tapping_term_report by get_u16_str * Replace tab with 4 spaces
2021-11-03Basic keycode overhaul (#14726)Ryan1-12/+13
2021-10-07Purge uGFX. (#14720)Nick Brassel1-5/+0
* Purge uGFX. * Remove remnants of visualizer. * Remove remnants of uGFX.
2021-09-24[Docs] Broken FAQ hyperlink (#14578)clickclackwho1-1/+1
2021-07-13[Feature] Key Overrides (#11422)Jonas Gessner1-0/+1
2021-02-16Split transport mirror (#11046)XScorpion21-1/+0
* Split transport mirror support * Updated RGB Matrix to respond to electrical events instead of key events * split matrix slave fix
2020-03-23Add Post Processing to process_record (#4892)Drashna Jaelre1-0/+9
* Improve process_record system Code based on @colinta's * Rename and better handle functions * Fix incorrect function call to process_record_user * Add documentation for post_process_record * Add both get_event_keycode and get_record_keycode functions And add some comments about these functions * Update code format * Cleanup merge artifacts
2019-10-22Remove apostrophe from various abbreviations' plural forms (#7050)Max Rumpf1-3/+3
While this was historically a valid possibility, nowadays, it reads kinda weird, and the [Oxford Dictionaries Online suggests to avoid it](https://english.stackexchange.com/a/56010). Thus, I removed it everywhere I found it.
2019-03-18[Docs] Smallish overhaul of the docs (#5281)Drashna Jaelre1-0/+2
* Fix up Common functions doc * Add to extra commands to flashing doc * Rearrange and touch up Macros * Expand Newbs Flashing guide * Update process_record documentation * Add git to best practices name in sidebar * Expand FAQ for build/flashing * Add deprecated info to functions * Update docs/feature_macros.md Co-Authored-By: drashna <drashna@live.com> * Update docs/feature_macros.md Co-Authored-By: drashna <drashna@live.com> * Update docs/flashing.md Co-Authored-By: drashna <drashna@live.com> * Update docs/flashing.md Co-Authored-By: drashna <drashna@live.com> * Update docs/keymap.md Co-Authored-By: drashna <drashna@live.com> * Update docs/newbs_flashing.md Co-Authored-By: drashna <drashna@live.com> * Update docs/newbs_flashing.md Co-Authored-By: drashna <drashna@live.com> * Update docs/custom_quantum_functions.md Co-Authored-By: drashna <drashna@live.com> * Update docs/faq_build.md Co-Authored-By: drashna <drashna@live.com> * Update docs/feature_macros.md Co-Authored-By: drashna <drashna@live.com> * Update docs/keymap.md Co-Authored-By: drashna <drashna@live.com> * Fix up Common functions doc * Make pre-init example accurate * Update docs/custom_quantum_functions.md Co-Authored-By: drashna <drashna@live.com> * Zadig Driver catchall * Spelling Depriciated * Completely remove fn_actions section
2019-02-21Replace instances of KEYMAP with LAYOUTnoroadsleft1-6/+6
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.
2019-01-07Improve consistency in UNICODEMAP code and docs, update ↵Konstantin Đorđević1-28/+30
docs/understanding_qmk (#4774) * Remove unused UNICODE(n) macro, update docs * Add note about max length of unicode_map to docs * QK_UNICODE_MAP → QK_UNICODEMAP * Refactor process_unicode_map * process_unicode_map → process_unicodemap This is done for consistency: UNICODEMAP is the method (hence UNICODEMAP_ENABLE, process_unicodemap), whereas unicode_map is the mapping table itself. * Update references and ordering in docs/understanding_qmk * Add additional note to docs/understanding_qmk * &unicode_map[index] → unicode_map + index This avoids the issue of the compiler sometimes complaining about the array index being out of range * Update docs/getting_started_make_guide * Update method sections in docs/feature_unicode
2018-09-17Make `PREVENT_STUCK_MODIFIERS` the default (#3107)Joe Wasson1-1/+1
* Remove chording as it is not documented, not used, and needs work. * Make Leader Key an optional feature. * Switch from `PREVENT_STUCK_MODIFIERS` to `STRICT_LAYER_RELEASE` * Remove `#define PREVENT_STUCK_MODIFIERS` from keymaps.
2018-08-29Docs: add process_terminal() and update links to other functions (#3778)arlenk1-24/+29
* add process_terminal() and update links to other functions * convert links to permalinks and add a few missing process_* functions * update links in main text as well
2018-03-01Fixed dead links (#2451)Brian Choromanski1-3/+3
* Fixed typo of 'confid.h' to 'config.h' * Fixed broken links in docs * Fixed a lot of dead links
2017-12-09Trim trailing whitespacefauxpark1-3/+3
2017-11-30Fix internal links in docs/ (#2080)Devin J. Pohly1-1/+1
One link in the summary (Modding your keyboard) referred to a page that was deleted; the rest have been updated to point to the new names.
2017-09-18Added Auto Shift, tap key = normal, hold key = shifted state.Jeremy Cowgar1-0/+1
2017-08-16Doc updates from going through every fileskullY1-1/+1
2017-07-03Update a bunch of docsskullY1-74/+54
2017-06-29Fixup the gitbook configskullY1-2/+2
2017-06-29Add some gitboot pluginsskullY1-0/+2
2017-06-28Rough draft for a document on understanding QMKskullY1-0/+190
generated by cgit v1.2.3 (git 2.25.1) at 2026-09-03 06:56:31 +0000