larryh/corso
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
corso/docs/README.md
Niraj Tolia 85a06d2409
Corso documentation platform changes (#62) 
* Add tools requirements for Corso docs

* Add README.md to Vale checks and ensure a clean run

* Swap from Discord to GH discussions
2022-05-20 11:00:44 -07:00

1.0 KiB
Raw Blame History

Corso documentation

Corso documentation uses Docusaurus 2, a modern static website generator.

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

make check

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

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).