The website relies on docusaurus and
mdoc. Its sources are available
(page content, in Markdown) and
(docusaurus configuration mostly).
Some of its logic is handled via Ammonite.
1.6.x is installed. Alternatively,
fetch it via
$ (echo "#!/usr/bin/env sh" && curl -L https://github.com/lihaoyi/Ammonite/releases/download/1.6.2/2.12-1.6.2) > amm $ chmod +x amm
./amm rather than just
yarn / npm / npx
The website relies on yarn / npm / npx to fetch and run docusaurus. Ensure these are available on your PATH.
To generate the website once, run
$ amm website.sc generate
You can then run
$ npx http-server doc/website/build/coursier
to browse the website. This command starts a website to browse the generated documentation (its address should be printed in the console).
To run the website while watching its sources (which live under
$ amm website.sc watch
This runs both docusaurus and mdoc in watch mode. The former should open a browser window, that automatically refreshes upon changes.