mirror of
https://github.com/MichaelCurrin/mkdocs-quickstart.git
synced 2026-03-28 17:42:47 +01:00
25 lines
526 B
Markdown
25 lines
526 B
Markdown
# Deploy
|
|
> How to deploy a MkDocs site
|
|
|
|
|
|
See [Deploying Your Docs](https://www.mkdocs.org/user-guide/deploying-your-docs/) on the Mkdocs site for more details.
|
|
|
|
|
|
## Github Pages
|
|
|
|
_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.
|
|
|
|
```sh
|
|
mkdocs gh-deploy
|
|
```
|
|
|
|
See options:
|
|
|
|
```sh
|
|
mkdocs gh-deploy --help
|
|
```
|
|
|
|
_Note you cannot view the site before its pushed, so use the `build` or `serve` commands for that._
|