Felix Sargent
6d105f324b
Update docs to use “SQT” instead of “QUOTE” ( #839 )
...
* Update default keymap to use SQT
Instead of the invalid “QUOTE”
* Update keymap-example-file.md
* Update docs/docs/keymap-example.md
Co-authored-by: Pete Johanson <peter@peterjohanson.com>
Co-authored-by: Pete Johanson <peter@peterjohanson.com>
3 years ago
innovaker
a8c0c76fca
docs(setup): replace `zephyr-west-action` with `zmk-docker`
...
This should've been changed after #481 .
See: https://github.com/zmkfirmware/zmk/pull/481
PR: https://github.com/zmkfirmware/zmk/pull/845
3 years ago
innovaker
47043c86e9
docs: bump Zephyr documentation links to Zephyr v2.5.0
...
PR: https://github.com/zmkfirmware/zmk/pull/736
3 years ago
innovaker
c03046e54a
docs(setup): add `x86_64-linux` to Zephyr SDK setup filename
...
See: zmkfirmware/zmk-docker@b8341e185ab694f7c596b81d03ada34ac76d2f1c
PR: https://github.com/zmkfirmware/zmk/pull/736
3 years ago
innovaker
76979d293a
docs(setup): bump `ZSDK_VERSION` to `0.12.4`
...
PR: https://github.com/zmkfirmware/zmk/pull/736
3 years ago
Nick Winans
9c1319c4ff
feat(docs): Add nice!nano v2 to scripts, actions, and documentation
...
asdf
asdf
asdf
3 years ago
innovaker
576ce76ad3
docs(setup): fix whitespace in Fedora toolchain install command
...
Aligns Fedora whitespace with Debian.
4 years ago
innovaker
84a5fec458
docs(setup): remove extra slash from Fedora toolchain install command
4 years ago
innovaker
6f3a2529ae
docs(setup): fix whitespace mismatch in host dependencies
...
Replaces spaces with tabs (bzip2).
4 years ago
Peter Johanson
3f4839ec96
refactor: Move to new zmk.dev domain name.
4 years ago
Peter Johanson
ba45aaa81b
chore(docs): Bump prettier, and reformat w/ it.
...
* Bump to prettier 2.3.1.
* Re-run prettier:format to apply updated format.
4 years ago
Peter Johanson
7323f78a37
fix(docs): Upgrade docusaurus, webpack/loaders.
...
Upgrade to the new Docusaurus 2 beta release, which also required
upgrades to newer Webpack@5, and some API fixes for TOC changes.
4 years ago
Martin Eberhardt
87ee2304a1
feat(docs): Add icon legend to the feature matrix
...
Add icon legend to the feature matrix
4 years ago
Dom H
06a85f944f
docs(codes): Refer to LSHIFT instead of LSHFT
...
`LSHIFT` is slightly more intuitive and should result in fewer user
errors.
4 years ago
Ivan Smirnov
bb32005474
fix(docs): Update macos GCC embedded section with brew cmd
...
* Update macos GCC embedded section with brew cmd
Brew has a cask for GCC embedded, so we can make this guide more user friendly by providing it.
4 years ago
Christian Stücklberger
8196b1d46b
fix(docs): Add missing semicolon to examples
...
Co-authored-by: Christian Stücklberger <christian.stuecklberger@ergon.ch>
4 years ago
Michael van Eerd
fadb508671
fix(docs) omit layers -1 example, clarify it defaults when omitted ( #757 )
...
* fix(docs) omit layers -1 example, clarify
* comment, simplify description
* remove 'the'
4 years ago
measlesbagel
3893d50e13
Docs: added mod morph page ( #749 )
...
* docs(behaviors): add mod-morph doc page
* docs(behaviors): add mod-morph doc page
* docs(mod-morph): add note about sent modifiers
* docs(mod-morph): fixed prettier formatting
4 years ago
Cody McGinnis
d956193251
change "Under Development" to "Beta Testing"
4 years ago
Cody McGinnis
ac50e741be
move the information to its own page
4 years ago
Cody McGinnis
daf10d9741
feat(docs): add information for testing PRs
4 years ago
Megamannen
a7c6e080a7
Fix broken link in documentation (encoders) ( #707 )
...
* Update encoders.md
Link to "New Keyboard Shield" didn't work
* Update encoders.md
Forgot hash-link
4 years ago
Megamannen
0a7491af87
Add detailed pin mapping explanation to underglow docs ( #709 )
...
* Update underglow.md
Updated the documentation according to my current understandring of how to pin-mapping works, also split the chapter into a nrf-section and a non-nrf-section since that information isn't applicable to both
* Ran prettier and updated pin reference according to suggestion
4 years ago
Okke Formsma
0c1940bb79
feature(hold-tap): no-hold-flash for retro taps
...
This is an improvement on retro-tap, solving the 'flashing hold' issue
users people experience.
When the tapping-term expires, the hold key is normally pressed. When
retro-tap is enabled, this is undesirable; only an interrupted hold-tap
should trigger the hold behavior.
This change disables the hold behavior for the 'STATUS_HOLD_TIMER'
state when retro-tap is enabled, and makes sure the
'STATUS_HOLD_INTERRUPT' state will be triggered when appropriate.
4 years ago
Okke Formsma
89ed816c67
feature(hold-tap): Retro tapping
4 years ago
Okke Formsma
af9d6e9b05
style(hold-tap)!: Write hold-tap params with dashes
...
tapping_term_ms -> tapping-term-ms
quick_tap_ms -> quick-tap-ms
The old style works, although it's deprecated.
4 years ago
Joel Spadin
24ed1a8eaa
docs(vscode): add more info for compile_commands.json path
4 years ago
Joel Spadin
0955ffef65
docs: Add docs for setting up vscode
...
Added a docs page with tips for setting up VS Code's code completion to work
in ZMK's source files. Info for other IDEs can be added here later as needed.
4 years ago
Pierre Constantineau
b67156b3f4
feat(docs): Update to BlueMicro_BLE Features
4 years ago
Pete Johanson
ae5056d680
Update docs/docs/behaviors/bluetooth.md
...
Co-authored-by: innovaker <66737976+innovaker@users.noreply.github.com>
4 years ago
Jonathan Rascher
1368a6481e
docs: Explain ZMK stays connected to inactive host
...
This behavior was not obvious to me, and I actually considered reporting
it as a bug until @Nicell explained to me on Discord that it's WAI. :)
4 years ago
KemoNine
cd503ed17b
Feat combo layers ( #661 )
...
feat(combos): add layer filtering
Co-authored-by: KemoNine <mcrosson@kemonine.info>
4 years ago
Okke Formsma
9a7908b632
behaviors(hold-tap): Implement quick_tap_ms (TAPPING_FORCE_HOLD)
...
Tap-and-hold a hold-tap to hold the tap behavior so it can repeat.
After a tap, if the same key is pressed within `quick_tap_ms`, the
tap behavior is always picked.
This is useful for things like `&ht LSHFT BACKSPACE` where holding
the backspace is required.
Implements #288 .
4 years ago
Aaron Nunley
bcc3d9b5a6
Update build/flash documentation.
...
Updated docs for the build and flash to have similar content to the new board page.
Added a bit about DFU in case someone were searching for that term.
4 years ago
Aaron Nunley
592b98cd12
npm run prettier:format
4 years ago
Aaron Nunley
100d06ae8b
Update docs for testing a new shield.
...
Clarifying the need for `west flash` in a dockerized environment and providing a high-level overview of testing a board with UF2 support.
4 years ago
Nick Winans
f39121f82e
fix(docs): Remove comment about here being four profiles for splits
4 years ago
Nick Winans
cba85d400d
fix(docs): Only show push workflow builds in link
4 years ago
KemoNine
1adb2d5f84
feat(docs): add information on how to update the documentation to the docs
4 years ago
Okke Formsma
89567d3150
docs(sticky keys): document sticky keys and sticky layers
4 years ago
Pete Johanson
e8aa576781
refactor(docs): Move combos under Features.
...
* Since combos aren't a behavior, but a new high level keymap
feature, move under Features section.
4 years ago
innovaker
13e46bea81
docs(hold-tap): mark tapping_term_ms as code
...
Improves readability and consistency.
4 years ago
Okke Formsma
feb0d5b90c
feat(combos): initial implementation
...
closes #45
4 years ago
Nick Winans
0c6686f6e8
docs(split): Remove USB configuration on right half
4 years ago
KemoNine
af563e9dbc
Fix parameter number
4 years ago
KemoNine
79b4a0ea6f
Add RGB_COLOR_HSB to lighting documentation
4 years ago
Nick Winans
167600f01d
docs(logging): Update documentation on USB logging
4 years ago
Nick Winans
56ec200bae
docs(intro): Add 💡 to Mouse Keys and BLE Shell
4 years ago
Nick Winans
ad238d63df
docs(intro): Update feature table
4 years ago
Okke Formsma
4c1f615714
docs(troubleshooting): fix reset uf2 download instructions
...
PR: #512
Co-authored-by: innovaker <66737976+innovaker@users.noreply.github.com>
4 years ago