f8e88d78c4
docs: Add docs on hardware metadata files.
3 years ago
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
d956193251
change "Under Development" to "Beta Testing"
4 years ago
ac50e741be
move the information to its own page
4 years ago
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
1adb2d5f84
feat(docs): add information on how to update the documentation to the docs
4 years ago
89567d3150
docs(sticky keys): document sticky keys and sticky layers
4 years ago
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
feb0d5b90c
feat(combos): initial implementation
...
closes #45
4 years ago
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
4 years ago
2744f44e73
refactor(docs): Integrate `Dev Guides` into `Development` section
...
Improves discoverability.
4 years ago
2d50302a02
refactor(docs): Integrate `USB Logging` into `Development` section
...
Improves discoverability.
4 years ago
532c1987b2
refactor(docs): Move `dev-` documents into `/development`
...
Aligns to conventions introduced by newer documentation.
4 years ago
bb43c7e053
docs: Rename `someSidebar` to `docs`
4 years ago
2871dca9bf
refactor(docs): Change `behavior` to `behaviors`
...
Makes a better URL.
4 years ago
a685d88744
refactor(docs): Change `feature` to `features`
...
Makes a better URL.
4 years ago
0d02441abe
docs(codes): add modifier functions
...
Refactor and expand codes documentation to include modifier functions.
Closes #330 .
4 years ago
ff638eb010
docs(codes): Add (key) codes documentation
...
Create codes documentation for standardized keys.
Closes #218 . Fixes #308 . Ref #21 .
4 years ago
2fe1fbb526
feat(endpoints): rename behavior to outputs
...
"Outputs" is probably easier for most people to understand than "endpoints".
4 years ago
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
4 years ago
288e60ea97
docs: Format docs with prettier
...
npx prettier --write .
4 years ago
cc21167d57
Added docs for external power output
4 years ago
a58a8412c7
Documented Issue #220
4 years ago
cf970efb98
feat(bluetooth): Proper bond management, identity support for non-splits
...
* Add `bt` behavior that can be used to perform certain actions,
such as next/prev identity, reset identity, etc.
NOTE: Multiple identities is only supported for non-split shields,
due to missing Zephyr identity functionality for dual
central/peripheral devices.
* Proper bond reset tied to action, that honors peripheral bonds,
so folks can reset and pair to other hosts, without breaking
bonds between splt halves.
4 years ago
bdeb6865e1
Update sidebars.js
4 years ago
e559cb2d71
Add hold-tap to sidebar.
4 years ago
6f74e61dd3
Added user and dev encoder docs
4 years ago
068626d1a7
Some work on encoder docs
4 years ago
dad2d339b3
Added customization page
4 years ago
35dc46bfbb
Made separate build and flash page with updated content
4 years ago
26414a6982
fix(docs): move testing docs to website docs
4 years ago
805ea77005
feat(behaviors): Add `&bootloader` behavior.
...
* Allow reset behavior to have a type property.
* Add `bootloader` node that triggers DFU UF2
bootloader mode using the AdaFruit nrf52
bootloader.
4 years ago
feadfc93dc
feat(docs): create a bond clearing page
4 years ago
d2d9fc86cf
feat(docs): Basic mod-tap behavior docs.
4 years ago
63e02d60dc
feat(behaviors): Add &none behavior
4 years ago
c92f114efe
Add lighting behavior docs
4 years ago
dd8deceed0
Add basic layer behavior docs.
4 years ago
14eef91da1
Better user setup docs.
4 years ago
10683fe1f8
Docs re-org, start of some keymap docs.
4 years ago
e1ea833bb3
Flesh out documentation skeleton.
4 years ago
fedd4381c2
Initial user setup docs, setup script fixes.
4 years ago
092fa866af
Add doc on enabling USB logging.
4 years ago
48f3f86a83
Initial shield dev guide.
4 years ago
bd1e2b069b
Expanded dev docs on boards/shields/keymaps.
4 years ago
c14beb7ee7
docs: Switch positions of 'hardware' and 'faq' on sidebars [ #22 CR, #11 ]
4 years ago
30985517b8
docs: add faq to sidebars [ #11 ]
4 years ago
d11ade45d3
[ #16 ] Replaced 'Basics' with 'Getting Started'
4 years ago
749df61a2e
Add docs about clean room design.
5 years ago
e00408d746
Initial work on basic documentation.
5 years ago
Peter Johanson