diff --git a/docs/index.md b/docs/index.md index b876226..1e8e45e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,7 +4,7 @@ [![Repo stars](https://img.shields.io/github/stars/MichaelCurrin/mkdocs-quickstart?style=social)](https://github.com/MichaelCurrin/mkdocs-quickstart) -Use the MkDocs (make docs) tool to create build a docs site around markdown docs. +Use the MkDocs (make docs) tool to create build a docs site around markdown docs. Follow the tutorial to add an existing project or create a project from scratch. The result will look like this project. diff --git a/docs/tutorial/tldr.md b/docs/tutorial/tldr.md index a0e83e2..1e8498c 100644 --- a/docs/tutorial/tldr.md +++ b/docs/tutorial/tldr.md @@ -1,14 +1,18 @@ -## TL;DR +# TL;DR > A simplified version of the tutorial. -### Local setup and deploy + +## Local setup and deploy 1. `pip install mkdocs` -2. `mkdocs new .` or click _Use this Template_ for this project. +2. Setup project + - Generate new - `mkdocs new .` + - Copy this project - [![Use this template](https://img.shields.io/badge/Use_this_template-green.svg)](https://github.com/MichaelCurrin/mkdocs-quickstart/generate) 3. `mkdocs serve` 4. `mkdocs gh-deploy` -5. View published site on Github Pages at [https://USERNAME.github.io/REPO-NAME/]() +5. View published site on Github Pages at `https://USERNAME.github.io/REPO-NAME/` -### Remote deploy + +## Remote deploy For CI/CD deploy, use Github Actions with an action such as [Deploy MkDocs](https://github.com/marketplace/actions/deploy-mkdocs). This is not covered in this tutorial.