The documentation website is powered by Docusaurus and served from Github Pages.
Adding or Updating Documentation
- Create a new branch off
- From the root of the project, run
npm run dev:docsto start a local server
- Add or edit markdown files in the
- Commit your changes and push to Github
- Open a Pull Request and mark it as ready for review
You can run the following commands from the root of the project:
|Start a local dev server|
|Format and lint markdown files|
|Run a build locally|
|Serve a statically generated version of the docs locally|
|Publish the docs to Github Pages (used by Github Actions)|
This repo uses a Github Action which automatically publishes changes to Github Pages.
The Github Action requires a key pair to be set up.
ssh-keygen -t ed25519 -C "email@example.com"
Copy the public key and add it to
Github Repo --> Settings --> Deploy Keys. The Private Key will be added as an ENV variable (see below).
The following ENV variables are required by
npm run publish:docs command. They must be added to
Github Repo --> Settings --> Secrets --> Actions
|Private key used to deploy to Github Pages|
|Email address used to commit to Github.|
|Name used to commit to Github|