The GeoTrellis docs website is built using Docusaurus 2.
Ensure you have Node 12+ installed.
In one terminal, run ./sbt "project mdoc;mdoc --watch"
in the parent directory.
This will run the mdoc watcher which recompiles docs in ../docs-mdoc
and writes the output to ./docs
.
Install project dependencies:
yarn install --pure-lockfile
Start the docusaurus dev server with:
yarn start
This will automatically recompile the docs site whenever the mdoc watcher writes updates to ./docs
.
Stop the sbt mdoc watcher and the yarn dev server.
Add a new file to ../docs-mdoc
.
Add an entry to ./sidebars.js
so that the new page appears somewhere in the doc tree. The Docusaurus sidebar docs have more info on how to configure the sidebar.
Restart both the mdoc watcher and the docusaurus server as described above.