kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
2522 commits 18 branches 0 tags 93 MiB
Commit graph

665 commits

Author SHA1 Message Date
Richard Titmuss
5d2120ad17 fix(docs): Typo EC11_CONFIG 
This should be CONFIG_EC11
 2021-09-24 02:15:56 -04:00
Dom H
c52887e236 fix(docs): Remove build.yml from new shield steps 2021-09-22 17:35:08 -04:00
Dom H
8bdd270c91 fix(docs): Set "Mouse Keys" as "Under Development" 2021-09-17 10:49:56 -04:00
Michael van Eerd
50174af658 fix(docs) add BT_PRV as suggested 
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2021-09-17 10:45:37 -04:00
Michael van Eerd
c27c1048e4 fix(docs) Bluetooth behavior typo 2021-09-17 10:45:37 -04:00
Michael van Eerd
748bc75587 fix(docs) Move Number of Profiles note down 2021-09-17 10:45:37 -04:00
Michael van Eerd
05b0353219 feat(docs) Clarify Bluetooth profile pairing 2021-09-17 10:45:37 -04:00
Richard Titmuss
d769618b3f fix(docs): Remove unnecessary security warning for MacOS 
The security warning applies for downloaded executables. If you are
following the instructions the toolchain is installed with brew and
the security warning does not apply. This is explained in the removed
link.
 2021-09-17 10:43:48 -04:00
Cem Aksoylar
33fa15a235
feat(docs): Add note to clarify shared .conf files do not apply outside zmk-config 2021-09-14 20:51:05 -04:00
Peter Johanson
7bf68f2a00 refactor(docs): Remove build.yml for new shield. 
* No longer recommending that all new shields get added to the
  build matrix in `build.yml`, so we avoid conflicts.
 2021-09-11 00:50:36 -04:00
Peter Johanson
f8e88d78c4 docs: Add docs on hardware metadata files. 2021-09-11 00:50:36 -04:00
Peter Johanson
47abbe7925 feat(docs): Add dynamic hardware list component. 2021-09-11 00:50:36 -04:00
chad3814
b235034dc9 fix typo 
"load your newly flashed firmware" not "load your newfly flashed fireware"
 2021-08-12 19:14:44 -05:00
Nick Winans
d964faaa89 fix(docs): Standardize all internal links 2021-08-12 20:07:45 -04:00
chad3814
689ba2d171
fix(docs): Fix "All" typo 2021-08-12 00:08:49 -04:00
Joel Spadin
6870fdc604 fix(docs): Appease Prettier 
Fixed code formatting in docs files.
 2021-08-08 13:17:27 -05:00
Peter Johanson
47109641d8 Add warning about peripheral encoders. 2021-08-04 22:25:41 -04:00
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>
 2021-07-27 18:18:52 -05:00
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
 2021-07-18 03:52:45 +01:00
innovaker
47043c86e9 docs: bump Zephyr documentation links to Zephyr v2.5.0 
PR: https://github.com/zmkfirmware/zmk/pull/736
 2021-07-17 17:04:25 -04:00
innovaker
c03046e54a docs(setup): add x86_64-linux to Zephyr SDK setup filename 
See: zmkfirmware/zmk-docker@b8341e185a
PR: https://github.com/zmkfirmware/zmk/pull/736
 2021-07-17 17:04:25 -04:00
innovaker
76979d293a docs(setup): bump ZSDK_VERSION to 0.12.4 
PR: https://github.com/zmkfirmware/zmk/pull/736
 2021-07-17 17:04:25 -04:00
Nick Winans
9c1319c4ff feat(docs): Add nice!nano v2 to scripts, actions, and documentation 
asdf

asdf


asdf
 2021-07-15 18:52:28 -04:00
innovaker
576ce76ad3 docs(setup): fix whitespace in Fedora toolchain install command 
Aligns Fedora whitespace with Debian.
 2021-06-16 16:23:53 -05:00
innovaker
84a5fec458 docs(setup): remove extra slash from Fedora toolchain install command 2021-06-16 16:23:53 -05:00
innovaker
6f3a2529ae docs(setup): fix whitespace mismatch in host dependencies 
Replaces spaces with tabs (bzip2).
 2021-06-16 16:23:53 -05:00
Peter Johanson
3f4839ec96 refactor: Move to new zmk.dev domain name. 2021-06-10 09:27:57 -04:00
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.
 2021-06-09 10:58:53 -04:00
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.
 2021-06-09 10:12:06 -04:00
Martin Eberhardt
87ee2304a1
feat(docs): Add icon legend to the feature matrix 
Add icon legend to the feature matrix
 2021-06-08 21:06:20 -04:00
Dom H
06a85f944f docs(codes): Refer to LSHIFT instead of LSHFT 
`LSHIFT` is slightly more intuitive and should result in fewer user
errors.
 2021-06-08 20:57:40 -04:00
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.
 2021-06-08 20:56:10 -04:00
Christian Stücklberger
8196b1d46b
fix(docs): Add missing semicolon to examples 
Co-authored-by: Christian Stücklberger <christian.stuecklberger@ergon.ch>
 2021-05-19 11:10:29 -04:00
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'
 2021-04-15 03:31:07 -05:00
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
 2021-04-05 18:04:38 -05:00
Cody McGinnis
d956193251 change "Under Development" to "Beta Testing" 2021-03-10 13:45:50 -05:00
Cody McGinnis
ac50e741be move the information to its own page 2021-03-10 13:45:50 -05:00
Cody McGinnis
daf10d9741 feat(docs): add information for testing PRs 2021-03-10 13:45:50 -05:00
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
 2021-03-03 00:06:29 -06:00
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
 2021-03-03 00:03:12 -06:00
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.
 2021-02-24 07:24:27 -05:00
Okke Formsma
89ed816c67 feature(hold-tap): Retro tapping 2021-02-24 07:24:27 -05:00
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.
 2021-02-10 07:55:12 -05:00
Joel Spadin
24ed1a8eaa docs(vscode): add more info for compile_commands.json path 2021-02-09 00:45:55 -05:00
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.
 2021-02-09 00:45:55 -05:00
Pierre Constantineau
b67156b3f4
feat(docs): Update to BlueMicro_BLE Features 2021-02-08 10:48:12 -05:00
Pete Johanson
ae5056d680 Update docs/docs/behaviors/bluetooth.md 
Co-authored-by: innovaker <66737976+innovaker@users.noreply.github.com>
 2021-02-04 07:45:55 -05:00
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. :)
 2021-02-04 07:45:55 -05:00
KemoNine
cd503ed17b
Feat combo layers (#661) 
feat(combos): add layer filtering

Co-authored-by: KemoNine <mcrosson@kemonine.info>
 2021-02-03 23:33:09 -05:00
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.
 2021-02-02 15:28:16 -05:00