corso/website

Corso documentation

Corso documentation uses Docusaurus 2, a modern static website generator. Mermaid provides support for native diagrams in Markdown.

Requirements

Developing documentation for Corso requires the following tools on your machine:

• make
• Docker

Installation

make buildimage

Live documentation development

make dev

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

Generating Corso CLI docs

make genclidocs

Corso's CLI documents are auto generated. This command explicitly triggers generating these docs. This step will happen automatically for the other commands where this is relevant.

Building static documentation

make build

This command generates static content into the build directory for integration with any static contents hosting service.

Serving static documentation

make serve

This command will serve the static content generated with make build at http://localhost:3000.

Style and linting

# Lint all docs
make check
# Lint specific files and/or folders
make check VALE_TARGET="README.md docs/concepts"

This command will lint all Markdown files and check them for style issues using the Docker container

Documentation platform development

make shell

Use this command to interactively (and temporarily!) change the contents or configuration of the live documentation container image (for example, when experimenting with new plugins).