This website is built using Docusaurus, a modern static website generator.
$ yarn
$ yarn 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.
$ yarn build
This command generates static content into the build directory and can be served using any static contents hosting service.
Using SSH:
$ USE_SSH=true yarn deploy
Not using SSH:
$ GIT_USER=<Your GitHub username> yarn deploy
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.
To lint a specific folder or file, run:
vale path/to/docs/
# or
vale path/to/*.mdTo lint the entire repo, run:
yarn lintInstall blacken-docs.
python -m pip install blacken-docsRun the formatter.
git ls-files -z -- '*.md' | xargs -0 blacken-docs