43 lines
854 B
Markdown
43 lines
854 B
Markdown
# Corso Documentation
|
|
|
|
Corso documentation is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
make buildimage
|
|
```
|
|
|
|
## Live Docs
|
|
|
|
```bash
|
|
make dev
|
|
```
|
|
|
|
This command starts a local development server within the Docker container and will expose docs at [http://localhost:3000](http://localhost:3000).
|
|
|
|
## Build Docs
|
|
|
|
```bash
|
|
make build
|
|
```
|
|
|
|
This command generates static content into the `build` directory and can be served using any static contents hosting service.
|
|
|
|
## Check Docs
|
|
|
|
```bash
|
|
make check
|
|
```
|
|
|
|
This command will lint all Markdown files and check them for style issues.
|
|
|
|
## Documentation Platform Development
|
|
|
|
```bash
|
|
make shell
|
|
```
|
|
|
|
This command is when you want to interactively (and temporarily!) change the contents or
|
|
configuration of the live documentation container image.
|