Skip to content

Quick start

Cloning the repo

Fork the repo, clone and install:

git clone https://github.com/ruanbekker/mkdocs-material-starter docs
cd docs
virtualenv -p python3 venv
source ./venv/bin/activate
pip install -r requirements.txt

Commands

  • mkdocs serve - Start a live reloading documentation site
  • mkdocs build - Building the documentation site

Explore

One of the examples is accessible by heading to the docker/flask-redis page.