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
Okke Formsma
0d02441abe
docs(codes): add modifier functions
...
Refactor and expand codes documentation to include modifier functions.
Closes #330 .
2020-11-07 12:00:19 -05:00
innovaker
5d04110a58
docs(key-press): Update for standardized keys
...
Replace existing HID Usage Tables link with links to the new codes documentation.
2020-11-06 15:02:12 -05:00
innovaker
642ec46c1f
docs(intro): Update for standardized keys
...
Update links to the new codes documentation.
2020-11-06 15:02:12 -05:00
innovaker
ff638eb010
docs(codes): Add (key) codes documentation
...
Create codes documentation for standardized keys.
Closes #218 . Fixes #308 . Ref #21 .
2020-11-06 15:02:12 -05:00
Pete Johanson
eff1b8223b
refactor(keys): Unify usage page.
...
* Remove need for separate `&cp` behavior, but
keep it for now for backward compat.
* Refactor sensor inc/dec as well.
2020-11-05 14:55:40 -05:00
innovaker
5f83568a93
docs(key press): Replace deprecated NUM_1
with N1
...
This should've been changed in: b8f6d52ae5
2020-11-05 11:47:34 -05:00
innovaker
651204c121
docs: Reformat example keymaps
...
Align to wider columns to improve readability for newcomers.
2020-11-03 23:50:54 -05:00
innovaker
b8f6d52ae5
docs: Replace deprecated key names
...
Follow-up to #21 .
2020-11-03 23:50:54 -05:00
Joel Spadin
c3e7742f9c
fix(docs): remove incorrect defines for outputs
...
The output selection behaviors page still referenced defines that were
removed while reviewing the PR. Updated the docs to match the code.
2020-11-03 19:38:56 -05:00
Nick
274fdec783
Add blog post about #322
2020-11-03 15:56:20 -05:00
Pete Johanson
fe62929af8
feat(docs): Add eslint and prettier GH Actions.
2020-11-03 15:02:41 -05:00
innovaker
a1dd216519
docs: formatted with prettier
2020-11-03 08:19:00 -05:00
Okke Formsma
4f258efbf1
initial implementation for modifiers
...
https://github.com/zmkfirmware/zmk/issues/86
2020-11-03 00:19:37 -05:00
Chiyuan Zhang
a9e729b427
make note about keyboard name more explicit
2020-11-02 23:30:03 -05:00
Chiyuan Zhang
9b941b7509
tweak doc according to PR feedback
2020-11-02 23:30:03 -05:00
Chiyuan Zhang
e7cb863a41
update doc for new shield in user repo
2020-11-02 23:30:03 -05:00
Evan
a32d14cc19
Add Github.com personal token to prerequisites.
2020-11-02 16:50:27 -05:00
innovaker
4672a0cbb5
docs(outputs): run prettier on outputs.md ( #317 )
...
Fixes #269
2020-10-31 12:00:02 -04:00
Pete Johanson
1766b090ee
feat(docs): Warn of battery life impact of logging
2020-10-31 00:30:19 -04:00
Pete Johanson
7e0924107c
feat(docs): Link to outputs behavior docs.
2020-10-31 00:23:16 -04:00
Joel Spadin
2fe1fbb526
feat(endpoints): rename behavior to outputs
...
"Outputs" is probably easier for most people to understand than "endpoints".
2020-10-28 18:15:05 -05:00
Joel Spadin
600bba25f0
feat(endpoints): add preferred endpoint setting
...
Added a new setting to remember the user's preferred endpoint. When both USB and
BLE are connected, the preferred endpoint will be used.
Added a new behavior to control this setting. It supports commands:
&end END_USB - Prefer USB output
&end END_BLE - Prefer BLE output
&end END_TOG - Toggle between USB and BLE
2020-10-28 18:15:05 -05:00
innovaker
806ea545f8
docs: Set netlify node version to lts/*
...
Prerequisite of #218 and PR #308 .
2020-10-26 22:55:15 +00:00
Pete Johanson
cb922fd8a2
feat(docs): Add Boardsource 3x4 to hardware list.
2020-10-27 23:32:44 -04:00
Jay Greco
d90592aac5
Add NIBBLE shield
...
+ Added required files for nullbits NIBBLE
2020-10-27 12:44:59 -07:00
Pete Johanson
3b9caaaf90
Merge pull request #304 from petejohanson/docs/cc-license-details
...
Explicitly license documentation as CC-BY-NC-SA.
2020-10-27 14:10:47 -04:00
Pete Johanson
2f09957ae2
Merge pull request #301 from innovaker/docs-eslint-prettier
...
docs: Add eslint, prettier and eslint-mdx support
2020-10-27 12:56:44 -04:00
Pete Johanson
c707ab45ef
Merge pull request #297 from Nicell/boards/reviung41
...
Add Reviung41 Shield Definitions
2020-10-27 00:27:17 -04:00