Piotr Gnus
96bd927be2
feat(docs): Added support for prefers-color-scheme in docs
...
Now, instead of always defaulting to light theme, documentation, docs
will default to the color scheme based by the user preference (reported
by web browser as a `prefers-color-scheme` media query).
It is still possible for user to change the theme by using the switch
next to the search box. His preference will be remembered.
3 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'
3 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
3 years ago
Nick Winans
4ef11ac4aa
feat(docs): Add power profiler
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
y4m4ym
9205ea1c70
fix(setup): Fix index to MakerDiary m.2 board
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
innovaker
40694a0969
docs: remove redundant slash from "docs/" navigation item
...
Aligns with the blog item.
PR: #608
4 years ago
Nick Winans
ddc5cbdca2
fix(docs): Set description to our tagline
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
Pete Johanson
a89d8a6ea4
fix(blog): Updated link to combos docs.
4 years ago
Pete Johanson
1addfb9769
feat(blog): Add SOTF #4
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
innovaker
90c2c6672f
fix(setup.sh): rename BF0-9000 to BFO-9000
...
Replaces BF0 (zero) with BFO.
Refs: dcd665999a
PR: #595
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
Pete Johanson
964b613e98
fix(setup): Fix typo for split variable assignment
4 years ago
innovaker
f0312092c7
fix(setup.sh): add NIBBLE to options
...
This was missing from its original commit.
Refs: f3153b17d2
4 years ago
innovaker
f17584ca0e
chore: standardize # style headers
...
Changes made with regex plus some manual tweaks.
Find:
/(?:(?<!#!\/bin\/sh\n)(?:^#\n))*^#.*?[Cc]opyright.*?(\d{4}) *([0-9A-z,_\- ]+).*?\n(?:^#\n)*^#.*?SPDX-License-Identifier:? *(.+) *?\n(?:^#\n)*/gm
Replace:
# Copyright (c) $1 $2
# SPDX-License-Identifier: $3
PR: #564
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
KingCoinless
5c11962d98
feat(shields): add helix shield
...
PR: #429
4 years ago
Nick Winans
a470353760
docs(shield): Add docs based on #510 changes
4 years ago
Pete Johanson
74b397ab91
fix(docs): Add closing bracket for new shield.
4 years ago
Nick Winans
4ddda7e024
docs(shield): Remove SPLIT_BLE_ROLE_PERIPHERAL
...
Removes CONFIG_ZMK_SPLIT_BLE_ROLE_PERIPHERAL from the new shield docs
See: #510
Refs: 4db5b169bf
4 years ago
pbz
dcd665999a
feat(shields): add bfo9000 shield
...
PR: #472
4 years ago