Skip to content

MkDocs โ€” Run and Build

Requirements:

  • Python 3.8+

Install MkDocs (and Material theme):

Terminal window
pip install mkdocs mkdocs-material

Create a new site:

Terminal window
mkdocs new my-mkdocs-site
cd my-mkdocs-site

Run locally:

Terminal window
mkdocs serve

Visit http://127.0.0.1:8000

Build for production (output to site/):

Terminal window
mkdocs build

Deploy the site/ directory to your static host.