summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2021-03-03Fix broken link in documentation (encoders) (#707)Megamannen
* Update encoders.md Link to "New Keyboard Shield" didn't work * Update encoders.md Forgot hash-link
2021-03-03Add detailed pin mapping explanation to underglow docs (#709)Megamannen
* 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-02-24feature(hold-tap): no-hold-flash for retro tapsOkke Formsma
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-24feature(hold-tap): Retro tappingOkke Formsma
2021-02-10style(hold-tap)!: Write hold-tap params with dashesOkke Formsma
tapping_term_ms -> tapping-term-ms quick_tap_ms -> quick-tap-ms The old style works, although it's deprecated.
2021-02-09docs(vscode): add more info for compile_commands.json pathJoel Spadin
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-02-08feat(docs): Update to BlueMicro_BLE FeaturesPierre Constantineau
2021-02-04Update docs/docs/behaviors/bluetooth.mdPete Johanson
Co-authored-by: innovaker <66737976+innovaker@users.noreply.github.com>
2021-02-04docs: Explain ZMK stays connected to inactive hostJonathan Rascher
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-03Feat combo layers (#661)KemoNine
feat(combos): add layer filtering Co-authored-by: KemoNine <mcrosson@kemonine.info>
2021-02-03fix(setup): Fix index to MakerDiary m.2 boardy4m4ym
2021-02-02behaviors(hold-tap): Implement quick_tap_ms (TAPPING_FORCE_HOLD)Okke Formsma
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-02Update build/flash documentation.Aaron Nunley
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-02npm run prettier:formatAaron Nunley
2021-02-02Update docs for testing a new shield.Aaron Nunley
Clarifying the need for `west flash` in a dockerized environment and providing a high-level overview of testing a board with UF2 support.
2021-01-30fix(docs): Remove comment about here being four profiles for splitsNick Winans
2021-01-30docs: remove redundant slash from "docs/" navigation iteminnovaker
Aligns with the blog item. PR: #608
2021-01-29fix(docs): Set description to our taglineNick Winans
2021-01-29fix(docs): Only show push workflow builds in linkNick Winans
2021-01-29feat(docs): add information on how to update the documentation to the docsKemoNine
2021-01-27fix(blog): Updated link to combos docs.Pete Johanson
2021-01-27feat(blog): Add SOTF #4Pete Johanson
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-21docs(hold-tap): mark tapping_term_ms as codeinnovaker
Improves readability and consistency.
2021-01-13feat(combos): initial implementationOkke Formsma
closes #45
2021-01-13fix(setup.sh): rename BF0-9000 to BFO-9000innovaker
Replaces BF0 (zero) with BFO. Refs: dcd665999a5ee04372559d56fc22b9a2d0784bf2 PR: #595
2021-01-08docs(split): Remove USB configuration on right halfNick Winans
2021-01-08Fix parameter numberKemoNine
2021-01-08Add RGB_COLOR_HSB to lighting documentationKemoNine
2021-01-08docs(logging): Update documentation on USB loggingNick Winans
2021-01-08fix(setup): Fix typo for split variable assignmentPete Johanson
2021-01-08fix(setup.sh): add NIBBLE to optionsinnovaker
This was missing from its original commit. Refs: f3153b17d293466160c03f7cb618a2be939c55f7
2021-01-06chore: standardize # style headersinnovaker
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-05docs(intro): Add 💡 to Mouse Keys and BLE ShellNick Winans
2021-01-05docs(intro): Update feature tableNick Winans
2021-01-05docs(troubleshooting): fix reset uf2 download instructionsOkke Formsma
PR: #512 Co-authored-by: innovaker <66737976+innovaker@users.noreply.github.com>
2021-01-05feat(shields): add helix shieldKingCoinless
PR: #429
2021-01-04docs(shield): Add docs based on #510 changesNick Winans
2021-01-04fix(docs): Add closing bracket for new shield.Pete Johanson
2021-01-04docs(shield): Remove SPLIT_BLE_ROLE_PERIPHERALNick Winans
Removes CONFIG_ZMK_SPLIT_BLE_ROLE_PERIPHERAL from the new shield docs See: #510 Refs: 4db5b169bff1f3de5353324baef5724be4f9a6a5
2021-01-02feat(shields): add bfo9000 shieldpbz
PR: #472
2021-01-01feat(shields): add eek shieldMango The Fourth
PR: #529
2021-01-01docs(codes): improve macOS support data (volume, brightness, media controls)Stephen Wu
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
2020-12-31feat(boards): Add BDN9 Rev2 board.Pete Johanson
* Onboard stm32f072. * 3 possible encoder positions. * Underglow/per-key not yet support.
2020-12-29(feature) Add &to keycode/behavior (#489)KemoNine
feat(behaviors): Add `&to` behavior to switch to a layer.
2020-12-28refactor: replace filename hyphens with underscoresinnovaker
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-18docs(setup): bump Zephyr SDK version to 0.11.4innovaker
Latest stable version. Also used in zmk-docker images.
2020-12-17docs(codes): improve iOS keyboard/keypad support dataonebigdoor
Co-authored-by: innovaker <66737976+innovaker@users.noreply.github.com> PR: #356 See: #376
generated by cgit v1.2.3 (git 2.25.1) at 2025-04-30 19:37:35 +0000