Skip to content

Commit 9a7a185

Browse files
authored
Documentation (#6267)
* added short description + links to MkDocs docu * hopefully better wording
1 parent 7353c7d commit 9a7a185

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/publishing-your-site.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,14 @@ the following command from the directory containing the `mkdocs.yml` file:
142142
mkdocs gh-deploy --force
143143
```
144144

145+
This will build your documentation and deploy it to a branch
146+
`gh-pages` in your repository. See [this overview in the MkDocs
147+
documentation] for more information. For a description of the
148+
arguments, see [the documentation for the command].
149+
150+
[this overview in the MkDocs documentation]: https://www.mkdocs.org/user-guide/deploying-your-docs/#project-pages
151+
[the documentation for the command]: https://www.mkdocs.org/user-guide/cli/#mkdocs-gh-deploy
152+
145153
## GitLab Pages
146154

147155
If you're hosting your code on GitLab, deploying to [GitLab Pages] can be done

0 commit comments

Comments
 (0)