245bb6e73e
* Bounce package.json verison to 0.1.0 * Docs cleanup driven by Vale * Clarifying language * Clarify that permissions bit is important * End of line white space linter warnings * Straighten what seemed like awkward constructs in prerequisites * Sync up with `docs/intro.md` Co-authored-by: Georgi Matev <gmatev@alcion.ai>
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.
Building static documentation
make build
This command generates static content into the build directory for integration with any static contents hosting service.
Style and linting
# Lint all docs
make dockercheck
# Lint specific files and/or folders
make dockercheck VALE_TARGET="README.md docs/concepts"
This command will lint all Markdown files and check them for style issues using the Docker container
make check
Same as make dockercheck but runs locally. Requires vale to be installed.
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).