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:33:19 +02:00
parent aa7a424e6e
commit a1396d49f2
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/deploy.md
View File

@@ -9,7 +9,9 @@ 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._
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.)
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). The default option is to clean the site directory first.
```sh
mkdocs gh-deploy