mirror of https://github.com/zmkfirmware/zmk.git synced 2026-03-20 04:55:20 -05:00

Files

Pete Johanson 21f54e7238 refactor(behaviors): Remove unneeded init funcs. (#2843 )

Initialization functions are optional for Zephyr drivers, so remove
all our superfluous empty init functions.

2025-02-26 17:54:29 -05:00

blog

docs: Move more sections under hardware integration (#2704 )

2025-01-13 21:14:25 -08:00

docs

refactor(behaviors): Remove unneeded init funcs. (#2843 )

2025-02-26 17:54:29 -05:00

src

docs: Add query strings to tabs (#2840 )

2025-02-25 16:31:57 -08:00

static

docs: Move more sections under hardware integration (#2704 )

2025-01-13 21:14:25 -08: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

docs: Added mastodon link in footer

2024-10-17 15:01:30 -06:00

netlify-ignore-command.sh

docs(ci): Netlify ignore command to check branch (#2659 )

2024-11-18 20:26:26 -05:00

netlify.toml

docs(ci): Netlify ignore command to check branch (#2659 )

2024-11-18 20:26:26 -05:00

package-lock.json

chore(deps): bump katex from 0.16.11 to 0.16.21 in /docs (#2774 )

2025-01-17 15:15:54 -08:00

package.json

chore(deps-dev): bump the development group across 1 directory with 7 updates (#2698 )

2024-12-13 10:07:46 +01:00

README.md

docs: Add syntax highlighting to more code blocks

2023-10-09 15:19:24 -07:00

sidebars.js

docs: Add a page on module creation (#2456 )

2025-02-14 16:32:18 -08:00

tsconfig.json

Update web-tree-sitter and tweak keymap upgrader (#2593 )

2024-10-26 09:55:09 +02:00

README.md

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.