mirror of
https://github.com/MichaelCurrin/mkdocs-quickstart.git
synced 2026-03-28 17:42:47 +01:00
480 B
480 B
TL;DR
A simplified version of the tutorial.
Local setup and deploy
pip install mkdocsmkdocs new .or click Use this Template for this project.mkdocs servemkdocs gh-deploy- 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.