This repository contains the NSW Mesh documentation wiki. It is built with Docusaurus and deployed to GitHub Pages by GitHub Actions.
npm install
npm run startThe local site runs at http://localhost:3000.
npm run build
npm run serveThe workflow in .github/workflows/pages.yml builds the site on pushes to main and publishes the generated build/ directory with GitHub Pages.
In GitHub, set Settings > Pages > Build and deployment > Source to GitHub Actions.
- Create or use the repository at
https://github.com/nswmesh/nswmesh.au. - Add the remote locally:
git remote add origin https://github.com/nswmesh/nswmesh.au.git- Push the repository:
git push -u origin mainIf the GitHub Pages URL differs from the defaults, set these repository variables in GitHub:
DOCUSAURUS_URL, for examplehttps://nswmesh.github.ioDOCUSAURUS_BASE_URL, for example/nswmesh.au/
For local builds, optionally set the repository override:
export DOCUSAURUS_REPOSITORY=nswmesh/nswmesh.au
export DOCUSAURUS_URL=https://nswmesh.github.io
export DOCUSAURUS_BASE_URL=/nswmesh.au/This ensures Docusaurus uses the correct repo path when building documentation links and page URLs.