adam/mkdocs-quickstart
1
0
Fork 0
mirror of https://github.com/MichaelCurrin/mkdocs-quickstart.git synced 2026-06-25 20:42:06 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update tldr.md

Browse Source
This commit is contained in:
michaelcurrin
2020-05-19 13:46:47 +02:00
committed by GitHub
parent 10bb3fabcc
commit e14b88702e
1 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/tutorial/tldr.md
+8 -2
View File
@@ -1,8 +1,14 @@
## TL;DR
> A simplified version of the tutorial.
### Local setup and deploy
1. `pip install mkdocs`
2. `mkdocs new .` or click _Use this Template_
2. `mkdocs new .` or click _Use this Template_ for this project.
3. `mkdocs serve`
4. `mkdocs gh-deploy`
5. View published site at [https://USERNAME.github.io/REPO-NAME/]()
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](https://github.com/marketplace/actions/deploy-mkdocs). This is not covered in this tutorial.