Website
The website relies on docusaurus and
mdoc. Its sources are available
under doc/docs
(page content, in Markdown) and
doc/website
(docusaurus configuration mostly).
Some of its logic is handled via Ammonite.
Setup
Ammonite
Ensure Ammonite 1.6.x is installed. Alternatively,
fetch it via
$ cs bootstrap ammonite:2.0.4 -o amm
Then run ./amm rather than just amm below.
yarn / npm / npx
The website relies on yarn / npm / npx to fetch and run docusaurus. Ensure these are available on your PATH.
Batch mode
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).
Watch mode
To run the website while watching its sources (which live under doc/docs), run
$ 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.