Getting Started with MkDocs¶

Reference: here

virtualenv -p python3 venv
. venv/bin/activate

pip install mkdocs

mkdocs new my-wiki
cd my-wiki

mkdocs serve -a 0.0.0.0:27015

Site Name¶

mkdocs.yml

site_name: attie.co.uk

rm -rf ./docs/
mkdir ./docs

echo "# Hello" > docs/index.md

mkdocs.yml

nav:
  - Home: index.md
  - About: about.md

mkdocs.yml

theme: readthedocs

mkdocs build