iarv/mkdocs-quickstart
1
0
Fork 0
mirror of https://github.com/MichaelCurrin/mkdocs-quickstart.git synced 2026-05-01 19:12:39 +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:37:33 +02:00
parent 7b729ba759
commit 0ae70d2fcd
3 changed files with 33 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
docs/tutorial/tldr.md
View File

@@ -2,17 +2,27 @@
> A simplified version of the tutorial.
## Local setup and deploy
## Local setup
1. `pip install mkdocs`
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/`
1. [Install](installation.md)
- `pip install mkdocs`
2. [Setup project](setup_project.md)
- `mkdocs new .` or [![Use this template](https://img.shields.io/badge/Use_this_template-green.svg)](https://github.com/MichaelCurrin/mkdocs-quickstart/generate)
3. [Run](usage.md)
- `mkdocs serve`
4. View on [http://localhost:8000](http://localhost:8000)
## Remote deploy
## Deploy to remote site
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.
### Run deploy command locally
1. [Deploy](deploy.md) to Github Pages
- `mkdocs gh-deploy`
2. View published site on Github Pages at `https://USERNAME.github.io/REPO-NAME/`
### Run continuous integration
For CI/CD deploy, use Github Actions with an action such as [Deploy MkDocs](https://github.com/marketplace/actions/deploy-mkdocs). Or use Netlify.
This is not covered in this tutorial.