Files
mkdocs-quickstart/docs/setup_and_run.md
2020-05-02 22:15:22 +02:00

510 B

Setup and run

How to setup and run the docs site

Install

Install in a virtual environment.

pip install mkdocs

Server docs locally

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.

mkdocs build

Useful for production build or simulating that locally.

Remove stale files.

mkdocs build --clean