This website is built using Docusaurus 2, a modern static website generator.
npm install -g yarn
This command will install the Yarn package manager. Yarn is used to build the project in the deployment pipeline.
yarn install
Installs all NPM packages and dependencies specified in the package.json file.
yarn start
This command starts a local development server and opens up a browser window. Most changes are refreshed 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 content hosting service.
The Continuous Integration workflow runs on a Pull Request into master, it uses Yarn to build the React project and checks for errors. If any errors make it through, the check fails and the fixes need to be made before merging the PR.
By default, GitHub Actions treats warnings as errors.
The Continuous Deployment workflow runs on a merge into master. It also uses Yarn to build/test the React code, and if successful, Deploys the code to the gh-pages branch. This then automagically updates the GH-Pages site.
Please use the Docusaurus Creating Pages Documentation to see how best to add to the pages.
When adding Markdown documentation the Docusaurus Markdown Features provides a full description. To add references to the Markdown the sidebar needs to be updated. Docusaurus Sidebar documents how this is structured.
Docusaurus uses a header in each Markdown file to specify the metadata for that page. The Markdown Header is enclosed with a line --- above and below it.
Each Markdown document in the Site should be identifiable through its file name (this is used as the file id if none is specified within the file itself).
Each Markdown document should have a title specified in its header section.
Where an alternative heading is required to be used in the sidebar, then a sidebar_label should be specified in the document header.