adam/mkdocs-quickstart
1
0
Fork 0
mirror of https://github.com/MichaelCurrin/mkdocs-quickstart.git synced 2026-08-12 11:53:01 +02:00
Code Issues Packages Projects Releases Wiki Activity

feat: Update pages

Browse Source
This commit is contained in:
Michael Currin
2020-06-02 22:19:04 +02:00
parent f45d546ccf
commit 928f697e0c
2 changed files with 10 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/index.md
+1 -1
View File
@@ -4,7 +4,7 @@
[![Repo stars](https://img.shields.io/github/stars/MichaelCurrin/mkdocs-quickstart?style=social)](https://github.com/MichaelCurrin/mkdocs-quickstart) [![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. Follow the tutorial to add an existing project or create a project from scratch. The result will look like this project.
docs/tutorial/tldr.md
+9 -5
View File
@@ -1,14 +1,18 @@
## TL;DR # TL;DR
> A simplified version of the tutorial. > A simplified version of the tutorial.
### Local setup and deploy
## Local setup and deploy
1. `pip install mkdocs` 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` 3. `mkdocs serve`
4. `mkdocs gh-deploy` 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. 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.