Nick Brassel
6ef9717288
Vitepress conversion of docs. ( #23795 )
2024-05-30 12:00:41 +10:00
James Kneafsey
a474cac2c3
Update keymap.md ( #22834 )
2024-01-06 12:06:14 +11:00
Pablo Martínez
95671148a4
[Docs] Change defines to enums in examples ( #19793 )
2023-02-10 02:39:35 -08:00
Ryan
801d2ff940
Remove useless line continuations ( #19399 )
2022-12-30 11:48:05 +11:00
Ryan
4b2d71de52
Remove legacy international keycodes ( #18588 )
2022-10-09 14:51:09 +11:00
Wes Lord
244f27ac27
Remove orphan custom functions reference in keymap docs ( #18444 )
2022-09-24 09:04:14 -07:00
kiilerix
da6d6ce2e1
Some docs improvements ( #15845 )
...
* 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 96e2b13d1d
2022-03-05 15:58:50 +11:00
Ryan
1d11ae3087
Rip out old macro and action_function system ( #16025 )
...
* Rip out old macro and action_function system
* Update quantum/action_util.c
Co-authored-by: Joel Challis <git@zvecr.com>
2022-01-24 21:22:20 +00:00
Ryan
f529580860
Basic keycode overhaul ( #14726 )
2021-11-03 22:22:17 -07:00
Nick Blyumberg
142ebaea46
[Docs] Clarify layer transparency keymap.md ( #9081 )
...
* Revised the grammar and clarity of the Layer Precedence and Transparency
* Update docs/keymap.md
* Update docs/keymap.md
* Update docs/keymap.md
* Update docs/keymap.md
* Update docs/keymap.md
* Update docs/keymap.md
* Update docs/keymap.md
2020-05-16 00:35:19 -07:00
skullY
54c58ea6de
Add explicit id tags to externally linked headers
2020-03-05 16:00:10 -08:00
Drashna Jaelre
c534a4c775
[Docs] Smallish overhaul of the docs ( #5281 )
...
* 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-03-18 14:22:02 -07:00
noroadsleft
384fef72d3
Replace instances of KEYMAP with LAYOUT
...
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-02-21 23:19:26 -08:00
Anthony Wharton
334e2629df
Remove redefinition of _______ in documentation example ( #3924 )
...
* Remove redefinition of `_______` in documentation example
* Slight rewording to include purpose of defintions
* Update include to newer macro
2018-09-19 16:18:15 -07:00
Drashna Jaelre
07b90db897
Fixes and updates to docs ( #2611 )
...
* Fix advanced keycode headers
* Add caveat for OSM over Remote Desktop
* Hopefully add better anchors to docs
* Add Action code list reference
* Formatting of RGB Underglow doc
* Add brew update issue on macOS
* Revert formatting
* Revert RGB doc formatting
* Make Config Options doc's sections linkable
2018-03-25 16:44:17 -07:00
Ben Hilburn
8df2ee4ec3
Minor updates to docs ( #2406 )
...
* [docs/] Cleaning up some language to make it more clear.
* [docs/] Adding instructions for installing deps on RH / Fedora.
2018-02-19 14:09:05 -05:00
fauxpark
bb53635f33
Trim trailing whitespace
2017-12-09 10:46:11 -05:00
fauxpark
7b0356d1d4
Convert all headings to Title Case
2017-12-09 10:46:11 -05:00
mmikeww
b9f426ae1e
Fix broken link in docs
...
This link was broken. And the latest, live version of that keymap link doesn't line up with the docs below, so the link will now point to the older version of the file in the git history
2017-12-02 23:55:58 -05:00
Zach Burchill
e236f1eba1
Fixed some grammar and typos on the docs ( #1989 )
...
* fixed grammar and references
* fixed typo
2017-11-09 16:18:31 -05:00
skullY
4e41beeaa6
Fix a typo
2017-11-02 01:30:51 -07:00
Dylan Khor
aa660c1eb7
Broken link found in issue #1845
2017-10-15 15:03:23 -10:00
skullY
9d1a08e38a
Doc updates from going through every file
2017-08-16 15:47:20 -04:00
Jack Humbert
ca01d94005
convert docs to lowercase and underscores
2017-06-10 14:58:24 -04:00
