Latest docs are deployed to
This website is built using Docusaurus 2, a modern static website generator.
The docs folder contains all pages in Markdown format.
npm install
Make sure that you have installed all the dependencies in your local environment. You only need to run this command the first time or after dependencies are updated.
npm start
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
The vale tool is used to verify the language style. After installing, verify the documentation with
vale sync vale docs/
Words not part of the dictionary yet are added in accept.txt.
To validate that the created Markdown follows the rules:
npm run lint:md