Divvi Up Documentation

This website is built using Docusaurus 2, a modern static website generator.

Local Development

yarn install
yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Deployment

On pull request merge to the main branch, GitHub Actions will build the site and push the generated contents to the gh-pages branch. GitHub Pages will then automatically pick up the new changes.

Formatting

GitHub Actions is configured to automatically format your code and content whenever you make a pull request, or changes to an existing pull request.

Be sure to review your changes after formatting, to make sure that the formatter didn't mess up your content. This usually only happens when using the admonition syntax.

If you're submitting a PR from a fork, or otherwise want to format your code locally, use:

npx prettier --write .