Dom H 6308ab9426 fix(docs): Ensure relative links always resolve Linking to the document _file path_ rather than the document _URL_ ensures that the link resolves regardless of trailing slash config. More information is at https://docusaurus.io/docs/docs-markdown-features		3 years ago
..
blog	fix(docs): Add `#include` to Underglow upgrade notes	3 years ago
docs	fix(docs): Ensure relative links always resolve	3 years ago
src	fix(docs): Clear up ambiguity on supported hardware page (#1200 )	3 years ago
static	feat: Generate setup scripts from metadata.	3 years ago
.eslintignore	docs: Add eslint support	4 years ago
.eslintrc.js	fix(docs): Updated eslint config for unified prettier setup.	4 years ago
.gitignore	Initial work on basic documentation.	5 years ago
.nvmrc	docs: Set netlify node version to lts/*	4 years ago
.prettierignore	feat: Generate setup scripts from metadata.	3 years ago
.prettierrc.js	docs: Set prettier endOfLine to auto	4 years ago
README.md	fix(docs): Explicit CC-BY-NC-SA license for docs.	4 years ago
docusaurus.config.js	fix(docs): Remove breadcrumbs (for now)	3 years ago
netlify.toml	fix(docs): Allow CORS for hardware-metadata.json	3 years ago
package-lock.json	chore(deps): bump browserslist from 4.14.5 to 4.20.2 in /docs	3 years ago
package.json	refactor(docs): Bump typescript dependency.	3 years ago
sidebars.js	feat(docs): Add battery sensor documentation	3 years ago
tsconfig.json	feat(docs): Type check the docs TSX components.	3 years ago

Website

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

License

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

$ npm ci

$ 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.

$ npm build

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