- Also renames `make vale` to `make check`
- Addresses a part of #15

2022-05-19 10:45:31 -07:00

Corso Documentation

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

$ make buildimage

$ make dev

This command starts a local development server within the Docker container and will expose docs at http://localhost:3000.

$ make build

This command generates static content into the build directory and can be served using any static contents hosting service.

$ make check

This command will lint all Markdown files and check them for style issues.

$ make shell

This command is when you want to interactively (and temporarily!) change the contents or configuration of the live documentation container image.