pwarren/zmk_mf68
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
1489 commits 1 branch 0 tags 16 MiB
Commit graph

484 commits

Author SHA1 Message Date
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.
 2021-05-05 00:15:38 -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
Nick Winans
4ef11ac4aa feat(docs): Add power profiler 2021-03-11 16:31:34 -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
y4m4ym
9205ea1c70
fix(setup): Fix index to MakerDiary m.2 board 2021-02-03 23:10:47 -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
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.
 2021-02-02 01:02:54 -05:00
Aaron Nunley
592b98cd12 npm run prettier:format 2021-02-02 01:02:54 -05:00
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.
 2021-02-02 01:02:54 -05:00
Nick Winans
f39121f82e fix(docs): Remove comment about here being four profiles for splits 2021-01-30 00:36:18 -05:00
innovaker
40694a0969 docs: remove redundant slash from "docs/" navigation item 
Aligns with the blog item.

PR: #608
 2021-01-30 00:02:11 -05:00
Nick Winans
ddc5cbdca2 fix(docs): Set description to our tagline 2021-01-29 23:58:42 -05:00
Nick Winans
cba85d400d fix(docs): Only show push workflow builds in link 2021-01-29 22:09:22 -05:00
KemoNine
1adb2d5f84 feat(docs): add information on how to update the documentation to the docs 2021-01-29 20:44:39 -06:00
Pete Johanson
a89d8a6ea4 fix(blog): Updated link to combos docs. 2021-01-27 22:49:57 -05:00
Pete Johanson
1addfb9769 feat(blog): Add SOTF #4 2021-01-27 22:48:14 -05:00
Okke Formsma
89567d3150 docs(sticky keys): document sticky keys and sticky layers 2021-01-24 23:30:05 -05:00
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.
 2021-01-24 16:42:44 -05:00
innovaker
13e46bea81 docs(hold-tap): mark tapping_term_ms as code 
Improves readability and consistency.
 2021-01-21 07:57:33 -05:00
Okke Formsma
feb0d5b90c feat(combos): initial implementation 
closes #45
 2021-01-13 21:07:41 -05:00
innovaker
90c2c6672f fix(setup.sh): rename BF0-9000 to BFO-9000 
Replaces BF0 (zero) with BFO.

Refs: dcd665999a
PR: #595
 2021-01-13 21:00:38 -05:00
Nick Winans
0c6686f6e8 docs(split): Remove USB configuration on right half 2021-01-08 16:51:50 -05:00
KemoNine
af563e9dbc Fix parameter number 2021-01-08 16:08:13 -05:00
KemoNine
79b4a0ea6f Add RGB_COLOR_HSB to lighting documentation 2021-01-08 16:08:13 -05:00
Nick Winans
167600f01d docs(logging): Update documentation on USB logging 2021-01-08 13:03:39 -05:00
Pete Johanson
964b613e98 fix(setup): Fix typo for split variable assignment 2021-01-08 11:11:20 -05:00
innovaker
f0312092c7 fix(setup.sh): add NIBBLE to options 
This was missing from its original commit.

Refs: f3153b17d2
 2021-01-08 11:02:35 -05:00
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
 2021-01-06 17:00:44 -05:00
Nick Winans
56ec200bae docs(intro): Add 💡 to Mouse Keys and BLE Shell 2021-01-05 19:37:00 +00:00
Nick Winans
ad238d63df docs(intro): Update feature table 2021-01-05 19:37:00 +00:00
Okke Formsma
4c1f615714
docs(troubleshooting): fix reset uf2 download instructions 
PR: #512
Co-authored-by: innovaker <66737976+innovaker@users.noreply.github.com>
 2021-01-05 19:29:47 +00:00
KingCoinless
5c11962d98
feat(shields): add helix shield 
PR: #429
 2021-01-05 18:56:47 +00:00
Nick Winans
a470353760 docs(shield): Add docs based on #510 changes 2021-01-04 14:08:00 -05:00
Pete Johanson
74b397ab91 fix(docs): Add closing bracket for new shield. 2021-01-04 11:59:25 -05:00
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
 2021-01-04 00:13:49 +00:00
pbz
dcd665999a
feat(shields): add bfo9000 shield 
PR: #472
 2021-01-02 18:52:50 +00:00
Mango The Fourth
5752b4fbda
feat(shields): add eek shield 
PR: #529
 2021-01-01 14:33:19 +00:00
Stephen Wu
2b4fda6948
docs(codes): improve macOS support data (volume, brightness, media controls) 
Codes:
- K_VOLUME_UP, C_VOLUME_UP, K_VOLUME_DOWN, C_VOLUME_DOWN, K_MUTE
- C_BRIGHTNESS_INC, C_BRIGHTNESS_DEC
- C_PLAY_PAUSE, C_NEXT, C_PREVIOUS

Tested on:
- Catalina 10.15.7
- Big Sur 11.2 Beta

PR: #541
See: #375
 2021-01-01 11:06:40 +00:00
Pete Johanson
39490552f2 feat(boards): Add BDN9 Rev2 board. 
* Onboard stm32f072.
* 3 possible encoder positions.
* Underglow/per-key not yet support.
 2020-12-31 14:46:15 -05:00
KemoNine
d207c3c30f
(feature) Add &to keycode/behavior (#489) 
feat(behaviors): Add `&to` behavior to switch to a layer.
 2020-12-29 11:57:49 -05:00
innovaker
842aa5a842 refactor: replace filename hyphens with underscores 
Aligns *.h and *.c to underscore naming convention.

These were kept (with warnings) for backwards compatibility with external boards/shields:
- kscan-mock.h
- matrix-transform.h
They should be removed in the future.

PR: #523
 2020-12-28 01:15:35 -05:00
innovaker
8fd9b619a7 docs(setup): bump Zephyr SDK version to 0.11.4 
Latest stable version.  Also used in zmk-docker images.
 2020-12-18 09:40:39 -05:00
onebigdoor
e89aa1cde8
docs(codes): improve iOS keyboard/keypad support data 
Co-authored-by: innovaker <66737976+innovaker@users.noreply.github.com>
PR: #356
See: #376
 2020-12-17 11:05:34 +00:00
KemoNine
565a72bf95 feat(shields): add tidbit and tidbit_19key shields 2020-12-17 10:57:06 +00:00
innovaker
8a529163fc docs(logging): remove CONFIG_USB_UART_DTR_WAIT 
This configuration option was removed in Zephyr v2.4.0.

See: zephyrproject-rtos/zephyr#27427
PR: #467
 2020-12-14 12:41:25 -05:00
Joel Spadin
5aa8a07aa9 feat(docs): add keymap upgrader 
Added a documentation page with a script that upgrades deprecated key
codes and behaviors to their replacements.

Fixes #299
 2020-12-10 12:23:05 +00:00
onebigdoor
4c92a4e50f
docs(codes): improve macOS support data 
Tested with Karabiner-EventViewer as well as some manual checks.

PR: #377
See: #375
 2020-12-09 13:58:24 +00:00
Chiyuan Zhang
02673e2f1d update doc about bluetooth 2020-12-08 01:11:48 -05:00
KemoNine
784ddfc620 Add note about cmake 3.19 not working with zephr ; addresses issue #487 2020-12-08 00:41:33 -05:00
ReFil
b0c525df72
feat(shields): add CRBN shield 
Co-authored-by: innovaker <66737976+innovaker@users.noreply.github.com>
PR: #483
 2020-12-07 16:49:37 +00:00
KemoNine
9c1a544381 Add note about default number of available profiles and how to increase if desired 2020-12-06 22:55:31 -05:00
KemoNine
52df05a545 Tweak/cleanup bluetooth documentation so it's more clear which codes should be used in keymaps as well as to call attention to BT_SEL requiring a second parameter 2020-12-06 22:55:31 -05:00
KemoNine
f8af592a9c Update cmake note to be 3.15 which is the current minimum version. This is a re-implementation of GitHub PR 403 2020-12-02 16:01:20 -05:00
Nick
a1d3230eef feat(underglow): RGB toggle controls ext_power 
fix(ug): Don't return if finding ext power fails

fix(ug): Move ext_power to a static variable

Add #if defs
 2020-11-22 21:23:29 -05:00
Okke Formsma
6573483a10 update errors in mod-tap docs 2020-11-22 21:06:42 -05:00
innovaker
3ebd192411 docs(key-press): remove references to key press 
This was obsoleted by eff1b8223b
 2020-11-21 15:23:11 -05:00
Okke Formsma
c067629c83 Create west test command to run zmk testsuite. 2020-11-21 14:47:01 -05:00
Okke Formsma
5d0532c6d9 improve hold-tap docs with better homerow example and more about flavors 2020-11-21 11:14:10 -05:00
innovaker
2744f44e73 refactor(docs): Integrate Dev Guides into Development section 
Improves discoverability.
 2020-11-20 22:31:56 -05:00
innovaker
2d50302a02 refactor(docs): Integrate USB Logging into Development section 
Improves discoverability.
 2020-11-20 22:31:56 -05:00
innovaker
532c1987b2 refactor(docs): Move dev- documents into /development 
Aligns to conventions introduced by newer documentation.
 2020-11-20 22:31:56 -05:00
Cody McGinnis
da08b4852d fix(setup): make sure selections are numbers 2020-11-19 19:32:53 -05:00
innovaker
3e65f6d472 docs(hold-tap): Capitalize hold-tap behavior document title 
Aligns with other documents.
 2020-11-18 10:47:59 +00:00
innovaker
bb43c7e053 docs: Rename someSidebar to docs 2020-11-18 10:47:08 +00:00
innovaker
c57c70465a fix(docs/codes): Patch footnotes array support 
Fixes bug that was noticeable when more than one code with a footnote array was present in a table.  The symptoms were:
- footnote descriptions were duplicated
- footnote refs were not rendered
 2020-11-18 10:45:40 +00:00
Caleb Lightfoot
d5250f0449 docs: Fix typo in PowerShell install script 
When I documented the PS install script in #210 I made a typo on the end.
 2020-11-17 20:56:27 +00:00
Caleb Lightfoot
3adbdffd0c docs: Add wired split FAQ 2020-11-17 20:56:27 +00:00
Caleb Lightfoot
4a8a6c58fb docs: Remove outdated HID note 
Removed outdated HID note from key-press.md
 2020-11-17 20:56:27 +00:00
krikun98
f60439802d Jian shield 2020-11-17 16:23:39 +00:00
krikun98
3d030ec2ab Jorne shield 2020-11-17 16:23:39 +00:00
Chiyuan Zhang
9388b24e7a zmk-config mounting based on docker volume 2020-11-16 22:49:20 -05:00
innovaker
28a4f33ee7 refactor(docs): Extract keymap examples into their own files 
Eases maintenance and promotes reuse.
 2020-11-16 21:39:38 -05:00
innovaker
18079e3bd3 fix(docs): Remove obsolete VID/PID CMake error 
This was obsoleted by 36d3d01a22.
 2020-11-16 17:33:59 -05:00
innovaker
6cf13f6b80 docs(key-press): Change codes to usages 
`usages` is a more accurate term in this context.
 2020-11-16 17:32:51 -05:00
innovaker
2871dca9bf refactor(docs): Change behavior to behaviors 
Makes a better URL.
 2020-11-16 15:33:44 -05:00
innovaker
a685d88744 refactor(docs): Change feature to features 
Makes a better URL.
 2020-11-16 15:33:44 -05:00
innovaker
aa8d0c1c79 refactor(docs): Remove explicit document ids (part 2) 
This was missed in: 4d42e792c5
 2020-11-12 07:42:48 -05:00
innovaker
4d42e792c5 refactor(docs): Remove explicit document ids 
Aligns older documents with newer file-based ids.
 2020-11-11 23:40:49 -05:00
Okke Formsma
d5cc504b3a docs: update modifier docs 2020-11-11 14:04:35 -05:00
Nick
ae51000d60 fix(underglow): Switch from legacy SPI to SPIM 2020-11-10 23:06:29 -05:00
Pete Johanson
0031f9bd4d
Merge pull request #357 from petejohanson/ble/remove-unpair-combo 
fix(ble): Remove unpair combo code.
 2020-11-10 15:04:28 -05:00
Pete Johanson
7d16186b7a fix(ble): Remove unpair combo code. 
* Favor the settings reset images for this.
 2020-11-10 14:53:03 -05:00
Nick Winans
413a917d14
Merge branch 'main' into underglow/add-config_ 2020-11-10 13:31:11 -06:00
Pete Johanson
edcfe380fe fix(blog): Quefrency typo fix. 2020-11-09 17:00:52 -05:00
Pete Johanson
9fe1793691 feat(blog): SOTF #3 2020-11-09 16:12:03 -05:00
Nick
0be904c34f fix(underglow): Add CONFIG_ to underglow Kconfigs 2020-11-08 10:33:56 -06:00