tgrosinger/zmk

History

Nicolas Munnich 308d6bce6e

feat(docs): Improve the toolchain setup page (#2272 )

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 <mcrosson@kemonine.info>
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>

2024-06-01 21:51:08 -07:00

..

feat(docs): Improve the toolchain setup page (#2272 )

2024-06-01 21:51:08 -07:00

feat(docs): Improve the toolchain setup page (#2272 )

2024-06-01 21:51:08 -07:00

feat(docs): Improve the toolchain setup page (#2272 )

2024-06-01 21:51:08 -07:00

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

feat(docs): Improve the toolchain setup page (#2272 )

2024-06-01 21:51:08 -07: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(docs): Improve the toolchain setup page (#2272 )

2024-06-01 21:51:08 -07:00

tsconfig.json

feat(keymap-upgrader): Upgrade renamed nodes

2024-01-25 18:03:37 -06: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.