aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/sidebars.js
AgeCommit message (Collapse)Author
2024-06-01feat(docs): Improve the toolchain setup page (#2272)Nicolas Munnich
Split the toolchain setup into separate docker and native pages and improve instructions to better refer to Zephyr docs in certain steps. Also refactor to improve consistency and add virtualenv instructions. --------- Co-authored-by: KemoNine <[email protected]> Co-authored-by: Cem Aksoylar <[email protected]>
2024-03-27feat: Add soft on/off support.Peter Johanson
Initial work on a soft on/off support for ZMK. Triggering soft off puts the device into deep sleep with only a specific GPIO pin configured to wake the device, avoiding waking from other key presses in the matrix like the normal deep sleep. Co-authored-by: Cem Aksoylar <[email protected]>
2024-03-24feat(docs): Add Behavior overview pageThomas Huber
Co-authored-by: Cem Aksoylar <[email protected]>
2024-01-25refactor: Improve keymap upgraderJoel Spadin
Moved the keymap upgrader to a top-level page like the power profiler to make it more discoverable. It upgrades more things than key codes now, so putting it in the codes category doesn't make much sense. Converted the upgrader code to TypeScript and split it up into smaller files to make it easier to add new upgrade functions. Added upgrade functions to remove/replace "label" properties and rename matrix-transform.h to matrix_transform.h.
2023-11-15feat(mouse): Initial mouse keys support.Alexander Krikun
* Add HID report/descriptor for a new report with mouse buttons, and x/y/wheel deltas. * New mouse key press behavior for press/release of mouse keys. * Add constants for HID main item values (e.g. data/array/absolute) * Define and use constants for our HID report IDs.
2023-04-24docs: Add pre-commit documentationJoel Spadin
2023-04-21feat(behaviors): Add reusable sensor behaviors.Nick Conway
* Add new sensor behaviors that either take full bindings add definition, or accept parameters when bound in the keymap. * Remove existing hard-coded key press sensor behavior and instead leverage new generic sensor behaviors to achieve the same functionality. Co-authored-by: [email protected]
2023-04-05feat(docs): Add BLE feature/config pages.Peter Johanson
Co-authored-by: Cem Aksoylar <[email protected]>
2022-07-03feat(docs): Update power and lighting config pagesJoel Spadin
Moved battery configuration to its own page to match the feature page. Documented that external power is disabled when in sleep mode. Clarified that the *_START configs apply on first boot, and any changes after that are persisted.
2022-07-03feat(docs): Updating lighting config docsJoel Spadin
2022-07-03docs: Add documentation for config optionsJoel Spadin
2022-06-03feat(docs): Add docs for key toggle behaviorCaleb Goates
2022-05-21feat(docs): Add New Behavior GuideKurtis Lew
Co-authored-by: Henré Botha <[email protected]> Co-authored-by: Cem Aksoylar <[email protected]> Co-authored-by: Dom H <[email protected]> Co-authored-by: Pete Johanson <[email protected]>
2022-04-17feat(docs): Add battery sensor documentationJoel Spadin
2022-03-23feat(docs): Document the macro behavior.Peter Johanson
2022-03-16feat(behaviors): Add Tap-Dance behaviorKurtis Lew
2022-02-12fix(docs): Add `behaviors/key-repeat` to sidebarDom H
2022-02-05feat(docs): add backlight documentationAlessandro Bortolin
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
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-26 13:41:24 +0000