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).
Setup
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
$ ./mill -i doc.generate --npm-install --yarn-run-build
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
$ ./mill -i doc.generate --npm-install --yarn-run-build --watch
This runs both docusaurus and mdoc in watch mode. The former should open a browser window, that automatically refreshes upon changes.