mirror of
https://github.com/MichaelCurrin/mkdocs-quickstart.git
synced 2026-03-28 17:42:47 +01:00
33 lines
651 B
Markdown
33 lines
651 B
Markdown
# Usage
|
|
> Build and preview a site locally
|
|
|
|
_Note: If using VS Code, you can use the command palette instead to run the configured tasks - these are setup in `.vscode/tasks.json`. However, using a `Makefile` allows more control locally and on for a remote build._
|
|
|
|
|
|
## Serve docs
|
|
|
|
This will build the docs in memory (not to disk) and serve an auto-reloading server.
|
|
|
|
```sh
|
|
mkdocs serve
|
|
```
|
|
|
|
Open URL:
|
|
|
|
- [localhost:8000](http://localhost:8000)
|
|
|
|
|
|
## Build docs
|
|
|
|
Build docs site to `site` directory. Useful for production build or simulating that locally.
|
|
|
|
```sh
|
|
mkdocs build
|
|
```
|
|
|
|
Add this flag to build in strict mode.
|
|
|
|
```sh
|
|
mkdocs build --strict
|
|
```
|