summaryrefslogtreecommitdiff
path: root/docs/sidebars.js
AgeCommit message (Collapse)Author
2021-11-28feat(behaviors): Add caps word (`&caps_word`).Peter Johanson
* Add new `&caps_word` behavior that acts like caps lock, but releases automatically when any "break" keycode is pressed.
2021-11-15docs(conditional-layers): Document featureJonathan Rascher
2021-10-26feat(kscan): Improve matrix debouncingJoel Spadin
Switched the GPIO matrix driver to debouncing using a simple integrator algorithm. Whenever a key is pressed, we now scan at a rate controlled by debounce-scan-period-ms (default 1 ms) until all keys are released, then return to either waiting for an interrupt or polling more slowly. The timers for key press and release can now be controlled separately, so debounce-period is deprecated in favor of debounce-press-ms and debounce-release-ms. Global Kconfig options ZMK_KSCAN_DEBOUNCE_PRESS_MS and ZMK_KSCAN_DEBOUNCE_RELEASE_MS are also added to make these easier to set. Added documentation for debouncing options.
2021-09-11docs: Add docs on hardware metadata files.Peter Johanson
2021-04-05Docs: added mod morph page (#749)measlesbagel
* 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-03-10change "Under Development" to "Beta Testing"Cody McGinnis
2021-03-10move the information to its own pageCody McGinnis
2021-02-09docs: Add docs for setting up vscodeJoel Spadin
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-01-29feat(docs): add information on how to update the documentation to the docsKemoNine
2021-01-24docs(sticky keys): document sticky keys and sticky layersOkke Formsma
2021-01-24refactor(docs): Move combos under Features.Pete Johanson
* Since combos aren't a behavior, but a new high level keymap feature, move under Features section.
2021-01-13feat(combos): initial implementationOkke Formsma
closes #45
2020-12-10feat(docs): add keymap upgraderJoel Spadin
Added a documentation page with a script that upgrades deprecated key codes and behaviors to their replacements. Fixes #299
2020-11-20refactor(docs): Integrate `Dev Guides` into `Development` sectioninnovaker
Improves discoverability.
2020-11-20refactor(docs): Integrate `USB Logging` into `Development` sectioninnovaker
Improves discoverability.
2020-11-20refactor(docs): Move `dev-` documents into `/development`innovaker
Aligns to conventions introduced by newer documentation.
2020-11-18docs: Rename `someSidebar` to `docs`innovaker
2020-11-16refactor(docs): Change `behavior` to `behaviors`innovaker
Makes a better URL.
2020-11-16refactor(docs): Change `feature` to `features`innovaker
Makes a better URL.
2020-11-07docs(codes): add modifier functionsOkke Formsma
Refactor and expand codes documentation to include modifier functions. Closes #330.
2020-11-06docs(codes): Add (key) codes documentationinnovaker
Create codes documentation for standardized keys. Closes #218. Fixes #308. Ref #21.
2020-10-28feat(endpoints): rename behavior to outputsJoel Spadin
"Outputs" is probably easier for most people to understand than "endpoints".
2020-10-28feat(endpoints): add preferred endpoint settingJoel Spadin
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-25docs: Format docs with prettierinnovaker
npx prettier --write .
2020-10-14Added docs for external power outputMega Mind
2020-10-09Documented Issue #220kurtis-lew
2020-09-13feat(bluetooth): Proper bond management, identity support for non-splitsPete Johanson
* 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.
2020-09-09Merge pull request #165 from kurtis-lew/troubleshootingPete Johanson
Troubleshooting - Revised Copy of PR 150
2020-09-06Update sidebars.jskurtis-lew
2020-09-06Merge pull request #154 from chenkevinh/docs/encodersPete Johanson
Encoder documentation
2020-09-03Add hold-tap to sidebar.Pete Johanson
2020-09-02Added user and dev encoder docsKevin
2020-09-01Some work on encoder docsKevin
2020-08-29Added customization pageKevin
2020-08-29Made separate build and flash page with updated contentKevin
2020-08-28fix(docs): move testing docs to website docsCody McGinnis
2020-08-21feat(behaviors): Add `&bootloader` behavior.Pete Johanson
* Allow reset behavior to have a type property. * Add `bootloader` node that triggers DFU UF2 bootloader mode using the AdaFruit nrf52 bootloader.
2020-08-19feat(docs): create a bond clearing pageCody McGinnis
2020-08-18feat(docs): Basic mod-tap behavior docs.Pete Johanson
2020-08-18feat(behaviors): Add &none behaviorPete Johanson
2020-08-08Add lighting behavior docsNick
2020-08-07Add basic layer behavior docs.Pete Johanson
2020-08-07Better user setup docs.Pete Johanson
2020-08-06Docs re-org, start of some keymap docs.Pete Johanson
2020-08-05Flesh out documentation skeleton.Pete Johanson
2020-08-04Initial user setup docs, setup script fixes.Pete Johanson
2020-07-07Add doc on enabling USB logging.Pete Johanson
2020-07-06Initial shield dev guide.Pete Johanson
2020-07-06Expanded dev docs on boards/shields/keymaps.Pete Johanson
2020-06-13docs: Switch positions of 'hardware' and 'faq' on sidebars [#22 CR, #11]innovaker
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-14 17:16:08 +0000