zmk/docs
Joel Spadin 76ffce6779 feat(behaviors): Add a send string behavior
This adds the following:

- A character map driver API, which maps Unicode code points to behavior
  bindings.

- A zmk,character-map driver which implements this API. This driver is
  designed for ROM efficiency, so it sends every value defined in the
  map to one behavior and passes any code point not in the map through
  to another. (A more flexible implementation that allows for a unique
  behavior binding per character could be added later if necessary.)

- A zmk,send-string behavior, which users can define and bind to their
  keymaps to send strings.

- A zmk_send_string() function, which queues the necessary behaviors
  to type a UTF-8 string. This is separated from the send string
  behavior since it could be used for other features such as Unicode
  key sequences, behaviors that print dynamic messages, etc.
2024-04-07 15:05:06 -05:00
..
blog feat: Add Zephyr 3.5 blog post. 2024-02-09 14:32:46 -08:00
docs feat(behaviors): Add a send string behavior 2024-04-07 15:05:06 -05:00
src feat(boards): Support board revisions in setup scripts. 2024-03-30 19:12:37 -04:00
static chore(docs): Update tree-sitter-devicetree to 0.9.0 2024-01-25 18:03:37 -06:00
.eslintignore docs: Add eslint support 2020-10-25 21:23:16 +00:00
.eslintrc.js ci(docs): Disable eslint rule for unescaped entities 2024-01-20 22:28:41 -08: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 refactor: Improve keymap upgrader 2024-01-25 18:03:37 -06:00
netlify.toml fix(docs): Allow CORS for hardware-metadata.json 2022-03-30 07:13:13 -04:00
package-lock.json chore(deps): bump react-toastify from 7.0.4 to 10.0.5 in /docs 2024-03-28 10:41:56 -07:00
package.json chore(deps): bump react-toastify from 7.0.4 to 10.0.5 in /docs 2024-03-28 10:41:56 -07:00
README.md docs: Add syntax highlighting to more code blocks 2023-10-09 15:19:24 -07:00
sidebars.js feat(behaviors): Add a send string behavior 2024-04-07 15:05:06 -05:00
tsconfig.json feat(keymap-upgrader): Upgrade renamed nodes 2024-01-25 18:03:37 -06: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.