iarv/mkdocs-quickstart
1
0
Fork 0
mirror of https://github.com/MichaelCurrin/mkdocs-quickstart.git synced 2026-03-28 17:42:47 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update deploy.md

Browse Source
This commit is contained in:
Michael Currin
2020-12-18 12:18:44 +02:00
committed by GitHub
parent 619a224358
commit e49c7ae2b3
1 changed files with 4 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/docs/tutorial/deploy.md
View File

@@ -11,10 +11,9 @@ See [Deploying Your Docs](https://www.mkdocs.org/user-guide/deploying-your-docs/
Follow one of the approaches below:
- [Run deploy command](#run-deploy-command) - Run a MkDocs CLI command locally to deploy.
- [Deploy with GitHub Actions](#deploy-with-github-actions) - use the project's workflow to build and deploy to GH Pages on commits pushed to master.
- [Deploy with GitHub Actions](#deploy-with-github-actions) - Use the project's CI workflow in the cloud to build and deploy to GH Pages on commits pushed to master.
_Note this is for a Project Page on a subpath and not an Organization or User Page._
_Note this is for a Project Page on a subpath, you will have to make adjustments to the command below if you want an Organization or User Page on the root path._
### Run deploy command
> Run a MkDocs CLI command locally to deploy
@@ -39,14 +38,13 @@ That will do the following:
2. Push to `gh-pages` branch. Note: You must not edit this branch directly.
3. Enable GitHub Pages if it was not yet enabled
Then go to your repo on GitHub, see the *environment* tab and click _View deployment_.
Then go to your repo on GitHub, look at the *environment* tab and click _View deployment_.
e.g.
- [michaelcurrin.github.io/mkdocs-quickstart/](https://michaelcurrin.github.io/mkdocs-quickstart/)
See deploy options:
See deploy options in the help:
```sh
$ mkdocs gh-deploy --help