pwarren/zmk_mf68
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
zmk_mf68/docs
History
Jonathan Rascher 96fea949d5 docs(docs): Document up-to-date Node.js repo 
For example, Debian Bullseye (current stable) packages Node.js version
12, which is too old to build the docs successfully. At least version 14
is required, and version 16 is current. General advice seems to be to
install from the NodeSource repo instead of your distro's repo, so I
added a suggestion to the docs.
2021-10-10 12:20:35 -07:00
..
blog feat(docs): Add Zephyr 2.5 blog post. 2021-07-17 17:04:25 -04:00
docs docs(docs): Document up-to-date Node.js repo 2021-10-10 12:20:35 -07:00
src fix(setup): Fix sed delimiters for Cradio 2021-09-24 15:56:36 -04: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 feat: Generate setup scripts from metadata. 2021-09-11 00:50:36 -04:00
package.json feat: Generate setup scripts from metadata. 2021-09-11 00:50:36 -04:00
README.md fix(docs): Explicit CC-BY-NC-SA license for docs. 2020-10-26 23:15:48 -04:00
sidebars.js docs: Add docs on hardware metadata files. 2021-09-11 00:50:36 -04:00
tsconfig.json feat(docs): Type check the docs TSX components. 2021-09-11 00:50:36 -04: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.