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

docs: Update deploy.md

Browse Source
This commit is contained in:
Michael Currin
2020-10-17 16:34:18 +02:00
parent b48560c99d
commit 54be3ff415
1 changed files with 10 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/tutorial/deploy.md
View File

@@ -14,7 +14,7 @@ Follow one of the approaches below:
- [Deploy with Githhub Actions](#deploy-with-github-actions) - Setup continous deployment config to enable deploys on a change to files on GitHub.
_Note this is for a Project Page and not Organization or User Pages._
_Note this is for a Project Page on a subpath and not an Organization or User Page._
### Run deploy command
> Run a MkDocs CLI command locally to deploy
@@ -24,7 +24,13 @@ MkDocs needs to know where to publish commits on GitHub - so make sure you are w
Run this command locally:
```sh
mkdocs gh-deploy
$ make d
```
That will use `Makefile` to run the following:
```sh
$ mkdocs gh-deploy --strict
```
That will do the following:
@@ -43,11 +49,11 @@ e.g.
See deploy options:
```sh
mkdocs gh-deploy --help
$ mkdocs gh-deploy --help
```
### Deploy with GitHub Actions
> Setup continous deployment config to enable deploys on a change to files on GitHub
> Setup continuous deployment config to enable deploys on a change to files on GitHub
When you make changes to your docs config or the docs directory, especially editing on GitHub directly, it's often useful to have the docs site build and deploy automatically in a remote environment. This is provided for free by GitHub.