mkdocs-quickstart/docs/setup_and_run.md

Inst and run

How to setup and run a docs site locally

Install

Make sure you have Python installed - ideally a recent Python 3 version.

Choose or setup a MkDocs project.

• Follow the tutorial page to setup a project.
• Or click Use this template on this repo to create your own copy of the repo, then clone it.

Create a virtual environment at the project root.

python3 -m venv venv

Install dependencies.

pip install mkdocs

Usage

Note: If using VS Code, you can use the command palette instead to run the configured tasks - these are setup in .vscode/tasks.json.

Server docs locally

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

mkdocs serve

Open URL:

• localhost:8000

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