zmk/docs
Kurtis Lew 2a518d1861 feat(behavior) Add Tap-Dance (2022)
Updated Tap-Dances to enable hold functionality

Update Documentation
- Edited for clarity and added Images

Uploaded New Tests

Updates according to test results of PR#1139

Docs edits based on @petejohanson's first review

Update behavior_tap_dance.c

- Removed `behavior_tap_dance_data{}` and associated lines
- Changed `new_tap_dance` of type `static struct active_tap_dance *` to type `static int`
- Changed logic of `new_tap_dance`
- Changed behavior_count of type `int` to type `size_t`

Update behavior_tap_dance.c

Updates according to test results of PR#1139

Update behavior_tap_dance.c

Update Documentation

Attempting to debug tap-dances interrupted by tap-dances

Update tests

Further updates

commit 26eeeccbc69b1bcb4a5d48fe858cdd8917e118ba
Author: Kurtis Lew <kurtis.a.lew@gmail.com>
Date:   Fri Feb 25 15:45:34 2022 -0800

    Attempting to debug tap-dances interrupted by tap-dances

    Update tests

commit a64fb2639ce8c0ca628e1924122b920e95582d43
Author: Kurtis Lew <kurtis.a.lew@gmail.com>
Date:   Sun Feb 20 19:30:59 2022 -0800

    feat(behavior) Add Tap-Dance (2022)

    Updated Tap-Dances to enable hold functionality

    Update Documentation
    - Edited for clarity and added Images

    Uploaded New Tests

    Updates according to test results of PR#1139

    Docs edits based on @petejohanson's first review

    Update behavior_tap_dance.c

    - Removed `behavior_tap_dance_data{}` and associated lines
    - Changed `new_tap_dance` of type `static struct active_tap_dance *` to type `static int`
    - Changed logic of `new_tap_dance`
    - Changed behavior_count of type `int` to type `size_t`

    Update behavior_tap_dance.c

    Updates according to test results of PR#1139

    Update behavior_tap_dance.c

    Update Documentation

Further updates

- Tap-dances can be interrupted by another tap-dance without memory leakage
- Confirmed functionality of tap-dances with only one keybind

Single-keybind hold tests

Further updates

commit 26eeeccbc69b1bcb4a5d48fe858cdd8917e118ba
Author: Kurtis Lew <kurtis.a.lew@gmail.com>
Date:   Fri Feb 25 15:45:34 2022 -0800

    Attempting to debug tap-dances interrupted by tap-dances

    Update tests

commit a64fb2639ce8c0ca628e1924122b920e95582d43
Author: Kurtis Lew <kurtis.a.lew@gmail.com>
Date:   Sun Feb 20 19:30:59 2022 -0800

    feat(behavior) Add Tap-Dance (2022)

    Updated Tap-Dances to enable hold functionality

    Update Documentation
    - Edited for clarity and added Images

    Uploaded New Tests

    Updates according to test results of PR#1139

    Docs edits based on @petejohanson's first review

    Update behavior_tap_dance.c

    - Removed `behavior_tap_dance_data{}` and associated lines
    - Changed `new_tap_dance` of type `static struct active_tap_dance *` to type `static int`
    - Changed logic of `new_tap_dance`
    - Changed behavior_count of type `int` to type `size_t`

    Update behavior_tap_dance.c

    Updates according to test results of PR#1139

    Update behavior_tap_dance.c

    Update Documentation

Further updates

- Tap-dances can be interrupted by another tap-dance without memory leakage
- Confirmed functionality of tap-dances with only one keybind

Fix tap-dances ability to be interrupted by other tap-dances

Update tests

Remove unecessary tests

Update tests

Update behavior_tap_dance.c

Further cleanup to comments and logging

Update behavior_tap_dance.c

Update tap-dance.md
2022-03-14 13:45:10 -07:00
..
blog feat(docs): add backlight documentation 2022-02-05 23:40:18 -05:00
docs feat(behavior) Add Tap-Dance (2022) 2022-03-14 13:45:10 -07:00
src feat(docs): add backlight to power profiler 2022-02-05 23:40:18 -05:00
static feat: Generate setup scripts from metadata. 2021-09-11 00:50:36 -04:00
.eslintignore docs: Add eslint support 2020-10-25 21:23:16 +00:00
.eslintrc.js fix(docs): Updated eslint config for unified prettier setup. 2021-05-05 00:54:55 -04:00
.gitignore Initial work on basic documentation. 2020-05-25 21:33:21 -04:00
.nvmrc docs: Set netlify node version to lts/* 2020-10-26 22:55:15 +00:00
.prettierignore feat: Generate setup scripts from metadata. 2021-09-11 00:50:36 -04:00
.prettierrc.js docs: Set prettier endOfLine to auto 2020-10-26 05:28:31 +00:00
docusaurus.config.js feat: Generate setup scripts from metadata. 2021-09-11 00:50:36 -04:00
netlify.toml fix(docs): Deploy when boards/shields change. 2021-09-11 00:50:36 -04:00
package-lock.json chore(deps-dev): bump json-schema-to-typescript in /docs 2022-02-05 23:31:00 -05:00
package.json chore(deps-dev): bump json-schema-to-typescript in /docs 2022-02-05 23:31:00 -05:00
README.md fix(docs): Explicit CC-BY-NC-SA license for docs. 2020-10-26 23:15:48 -04:00
sidebars.js feat(behavior) Add Tap-Dance (2022) 2022-03-14 13:45:10 -07:00
tsconfig.json feat(docs): Type check the docs TSX components. 2021-09-11 00:50:36 -04:00

Website

This website is built using Docusaurus 2, a modern static website generator.

License

The ZMK Documentation is licensed CC-BY-NC-SA.

Installation

$ npm ci

Local Development

$ npm start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

$ npm build

This command generates static content into the build directory and can be served using any static contents hosting service.