From c3c3613a71e63de4e736eac433e19b92de87130f Mon Sep 17 00:00:00 2001 From: Niraj Tolia Date: Thu, 19 May 2022 14:32:30 -0700 Subject: [PATCH] Docs: Allow for a clean run of `make check` (#57) --- docs/.markdownlint.json | 3 ++ docs/Makefile | 4 +-- docs/README.md | 36 +++++++++---------- docs/docs/intro.md | 1 - .../corso-repository-and-configuration.md | 4 +-- docs/styles/Vocab/Base/accept.txt | 1 + 6 files changed, 26 insertions(+), 23 deletions(-) create mode 100644 docs/.markdownlint.json diff --git a/docs/.markdownlint.json b/docs/.markdownlint.json new file mode 100644 index 000000000..933f52b79 --- /dev/null +++ b/docs/.markdownlint.json @@ -0,0 +1,3 @@ +{ + "MD013": { "line_length": 120 } +} diff --git a/docs/Makefile b/docs/Makefile index 3cb25cbed..a17538f1d 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -10,9 +10,9 @@ dev: check: 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 \ - -v ${PWD}:/usr/src/docs alcion/docs markdownlint '**/*.md' + -v ${PWD}:/usr/src/docs alcion/docs markdownlint '**/*.md' --ignore styles/ --ignore src/ shell: docker run --rm -it \ diff --git a/docs/README.md b/docs/README.md index ed73735bf..881f4989f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,41 +2,41 @@ Corso documentation is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. -### Installation +## Installation -``` -$ make buildimage +```bash +make buildimage ``` -### Live Docs +## Live Docs -``` -$ make dev +```bash +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 -``` -$ make build +```bash +make build ``` This command generates static content into the `build` directory and can be served using any static contents hosting service. -### Check Docs +## Check Docs -``` -$ make check +```bash +make check ``` This command will lint all Markdown files and check them for style issues. -### Documentation Platform Development +## Documentation Platform Development - -``` -$ make shell +```bash +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. diff --git a/docs/docs/intro.md b/docs/docs/intro.md index 1d04b9f98..204a43d26 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -8,7 +8,6 @@ Let's discover **Corso in less than 5 minutes**. ## Getting Started - ### What you'll need - Docker diff --git a/docs/docs/tutorial-basics/corso-repository-and-configuration.md b/docs/docs/tutorial-basics/corso-repository-and-configuration.md index 264afc817..44e7296cb 100644 --- a/docs/docs/tutorial-basics/corso-repository-and-configuration.md +++ b/docs/docs/tutorial-basics/corso-repository-and-configuration.md @@ -2,6 +2,6 @@ sidebar_position: 1 --- -# Repositories and Configuration +# Repositories and configuration -How to configure Corso... +How to configure Corso: diff --git a/docs/styles/Vocab/Base/accept.txt b/docs/styles/Vocab/Base/accept.txt index ac215e591..e43cc9337 100644 --- a/docs/styles/Vocab/Base/accept.txt +++ b/docs/styles/Vocab/Base/accept.txt @@ -1,2 +1,3 @@ +Corso Docusaurus