aboutsummaryrefslogtreecommitdiffstats
path: root/docs/understanding_qmk.md
Commit message (Collapse)AuthorAgeFilesLines
* Add Post Processing to process_record (#4892)Drashna Jaelre2020-03-231-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
* Remove apostrophe from various abbreviations' plural forms (#7050)Max Rumpf2019-10-221-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.
* [Docs] Smallish overhaul of the docs (#5281)Drashna Jaelre2019-03-181-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
* Replace instances of KEYMAP with LAYOUTnoroadsleft2019-02-211-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.
* Improve consistency in UNICODEMAP code and docs, update ↵Konstantin Đorđević2019-01-071-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
* Make `PREVENT_STUCK_MODIFIERS` the default (#3107)Joe Wasson2018-09-171-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.
* Docs: add process_terminal() and update links to other functions (#3778)arlenk2018-08-291-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
* Fixed dead links (#2451)Brian Choromanski2018-03-011-3/+3
| | | | | | | | * Fixed typo of 'confid.h' to 'config.h' * Fixed broken links in docs * Fixed a lot of dead links
* Trim trailing whitespacefauxpark2017-12-091-3/+3
|
* Fix internal links in docs/ (#2080)Devin J. Pohly2017-11-301-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.
* Added Auto Shift, tap key = normal, hold key = shifted state.Jeremy Cowgar2017-09-181-0/+1
|
* Doc updates from going through every fileskullY2017-08-161-1/+1
|
* Update a bunch of docsskullY2017-07-031-74/+54
|
* Fixup the gitbook configskullY2017-06-291-2/+2
|
* Add some gitboot pluginsskullY2017-06-291-0/+2
|
* Rough draft for a document on understanding QMKskullY2017-06-281-0/+190