Skip to content

Latest commit

 

History

History

docs

Website

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

Installation

First, you'll need to do at least one full build of Coral. In the root of the repository, peform the following.

sh pnpm-i.sh
sh scripts/build-development.sh

The reason for this is that the docs references the client/ and server/ generated types and components to populate the live docs information.

Local Development

Then within docs/ you can run the following:

pnpm run build
pnpm run start

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