Skip to content

Commit

Permalink
Documentation (#6267)
Browse files Browse the repository at this point in the history
* added short description + links to MkDocs docu

* hopefully better wording
  • Loading branch information
alexvoss authored Nov 2, 2023
1 parent 7353c7d commit 9a7a185
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/publishing-your-site.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,14 @@ the following command from the directory containing the `mkdocs.yml` file:
mkdocs gh-deploy --force
```

This will build your documentation and deploy it to a branch
`gh-pages` in your repository. See [this overview in the MkDocs
documentation] for more information. For a description of the
arguments, see [the documentation for the command].

[this overview in the MkDocs documentation]: https://www.mkdocs.org/user-guide/deploying-your-docs/#project-pages
[the documentation for the command]: https://www.mkdocs.org/user-guide/cli/#mkdocs-gh-deploy

## GitLab Pages

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

0 comments on commit 9a7a185

Please sign in to comment.