We use Docusaurus for our website.
If you want to run it locally, you can follow the instructions below, otherwise you should be able to edit most pages directly with a Markdown editor or IDE. Opening a pull request for your changes will generate a preview on Netlify that you can browse to check the rendering.
Building the website requires Node.js (LTS recommended), which includes the npm package manager.
Once you have installed Node, which includes the npm package manager, we can install and set-up the dependencies:
npm installThe following command starts a local development server and opens up a browser window. Usually at the URL http://localhost:3000.
Most changes you make to pages and content are reflected live without having to restart the server.
npm run startThe following command generates static content into the build directory and can be served using any static contents hosting service.
npm run buildYou can locally test (with parameters) the static content in the build directory (in case you don't have access to a hosting service) by using:
npm run serveIf you are using GitHub pages for hosting, this command is a convenient way to build the website
and push to the gh-pages branch.
GIT_USER=<Your GitHub username> USE_SSH=true npm run deployThis website is published under the Creative Commons Attribution 4.0 International License.