mkdocs-quickstart/docs/tutorial/tldr.md

TL;DR

A simplified version of the tutorial.

Local setup and deploy

1. pip install mkdocs
2. Setup project
   • Generate new - mkdocs new .
   • Copy this project -
3. mkdocs serve
4. mkdocs gh-deploy
5. View published site on Github Pages at https://USERNAME.github.io/REPO-NAME/

Remote deploy

For CI/CD deploy, use Github Actions with an action such as Deploy MkDocs. This is not covered in this tutorial.