mirror of
https://github.com/MichaelCurrin/mkdocs-quickstart.git
synced 2026-03-28 17:42:47 +01:00
feat: Update pages
This commit is contained in:
@@ -4,7 +4,7 @@
|
||||
[](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.
|
||||
|
||||
|
||||
@@ -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 - [](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.
|
||||
|
||||
Reference in New Issue
Block a user