Skip to content

nswmesh/nswmesh.au

Repository files navigation

NSW Mesh Wiki

This repository contains the NSW Mesh documentation wiki. It is built with Docusaurus and deployed to GitHub Pages by GitHub Actions.

Local Development

npm install
npm run start

The local site runs at http://localhost:3000.

Production Build

npm run build
npm run serve

GitHub Pages

The 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.

Repository setup

  1. Create or use the repository at https://github.com/nswmesh/nswmesh.au.
  2. Add the remote locally:
git remote add origin https://github.com/nswmesh/nswmesh.au.git
  1. Push the repository:
git push -u origin main

Pages URL configuration

If the GitHub Pages URL differs from the defaults, set these repository variables in GitHub:

  • DOCUSAURUS_URL, for example https://nswmesh.github.io
  • DOCUSAURUS_BASE_URL, for example /nswmesh.au/

Local development configuration

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.

About

NSWMesh Website 2.0

Resources

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors