Docs: Allow for a clean run of make check (#57)

This commit is contained in:
Niraj Tolia 2022-05-19 14:32:30 -07:00 committed by GitHub
parent 49aa63c349
commit c3c3613a71
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 26 additions and 23 deletions

3
docs/.markdownlint.json Normal file
View File

@ -0,0 +1,3 @@
{
"MD013": { "line_length": 120 }
}

View File

@ -10,9 +10,9 @@ dev:
check: check:
docker run --rm \ docker run --rm \
-v ${PWD}:/usr/src/docs alcion/docs vale --glob='*.md' . -v ${PWD}:/usr/src/docs alcion/docs vale --glob='docs/**/*.md' .
docker run --rm \ docker run --rm \
-v ${PWD}:/usr/src/docs alcion/docs markdownlint '**/*.md' -v ${PWD}:/usr/src/docs alcion/docs markdownlint '**/*.md' --ignore styles/ --ignore src/
shell: shell:
docker run --rm -it \ docker run --rm -it \

View File

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

View File

@ -8,7 +8,6 @@ Let's discover **Corso in less than 5 minutes**.
## Getting Started ## Getting Started
### What you'll need ### What you'll need
- Docker - Docker

View File

@ -2,6 +2,6 @@
sidebar_position: 1 sidebar_position: 1
--- ---
# Repositories and Configuration # Repositories and configuration
How to configure Corso... How to configure Corso:

View File

@ -1,2 +1,3 @@
Corso
Docusaurus Docusaurus