Skip to content

Latest commit

 

History

History
executable file
·
36 lines (23 loc) · 784 Bytes

README.md

File metadata and controls

executable file
·
36 lines (23 loc) · 784 Bytes

Documentation

Documentation for all things Project Caelus. Built using Docusaurus 2, a modern static website generator.

Usage

Install Dependencies

$ npm i

Local Development

$ npm run 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

$ GIT_USER=<Your GitHub username> USE_SSH=true npm run deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.