Files
mkdocs-quickstart/docs/tutorial/usage.md
2020-05-03 11:31:57 +02:00

580 B

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.

Serve docs

This will build the docs in memory (not to disk) and serve an auto-reloading server.

mkdocs serve

Open URL:

Build docs

Build docs site to site directory. Useful for production build or simulating that locally.

mkdocs build

Add this flag to remove stale files when building.

mkdocs build --clean