/circus-docs

Static docs site for CIRCUS project

Primary LanguageJavaScript

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

npm ci

Prebuild

echo 'CIRCUS_DOCS_GH_TOKEN=$(Personal access token of Github)' > .env
npm run prebuild

Local Development

npm start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

We use Netlify to build and deploy this documentation site.