Skip to content

Documentation website

The pages of this documentation live in the docs/ folder of the monorepo. The website that publishes them on opencolibri.github.io/starter/docs is built with Astro Starlight from the docs-site/ folder of the opencolibri/starter website, which deploys it under its /docs/ path and redeploys when docs/ changes on main.

Clone the website next to the monorepo, then serve the pages of your checkout:

Terminal window
git clone git@github.com:opencolibri/starter.git ../starter
castor docs:up # http://localhost:4321/starter/docs/, follows the changes of docs/
castor docs:up --port=4322 # on another port
castor docs:stop

castor docs:up installs the website dependencies on the first run and starts its dev server in the background. It serves the docs/ of the checkout it runs from: run it from a worktree to preview the pages of its branch. Only one server runs at a time, so it replaces any server started from another checkout. Set DOCS_SITE_DIR to the docs-site/ folder when the website is cloned elsewhere.