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

feat: Update deploy.md

Browse Source
This commit is contained in:
Michael Currin
2020-05-02 22:32:01 +02:00
parent 0fc7cffc9d
commit aa7a424e6e
1 changed files with 9 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/deploy.md
View File

@@ -9,16 +9,21 @@ See [Deploying Your Docs](https://www.mkdocs.org/user-guide/deploying-your-docs/
_Note this is for a Project Page and not Organization and User Pages._
Run this command locally to deploy to Github Pages by building and pushing to `gh-pages` branch.
How to deploy to Github Pages. Run this to build to `site` directory, push to `gh-pages` branch and enable Github Pages (if it was not yet enabled.)
```sh
mkdocs gh-deploy
```
See options:
Then go to your repo on Github, see the *environment* tab and click _View deployment_.
e.g.
- [michaelcurrin.github.io/mkdocs-quickstart/](https://michaelcurrin.github.io/mkdocs-quickstart/)
See deploy options:
```sh
mkdocs gh-deploy --help
```
_Note you cannot view the site before its pushed, so use the `build` or `serve` commands for that._