docs: Update docs

This commit is contained in:
Michael Currin
2020-10-17 16:23:20 +02:00
parent b842ce958e
commit 5e8b217c8d
4 changed files with 47 additions and 28 deletions

View File

@@ -9,24 +9,30 @@ _Note: If using VS Code, you can use the command palette instead to run the conf
This will build the docs in memory (not to disk) and serve an auto-reloading server.
```sh
mkdocs serve
$ make serve
```
Open URL:
That will use `make` to run the following:
```sh
$ mkdocs serve --strict
```
Then open in your browser:
- [localhost:8000](http://localhost:8000)
## Build docs
Build docs site to `site` directory. Useful for production build or simulating that locally.
Build docs site to `site` directory. This is useful for a CI flow.
```sh
mkdocs build
$ make docs
```
Add this flag to build in strict mode.
That will use `make` to run the following:
```sh
mkdocs build --strict
$ mkdocs build --strict
```