From 9a7a185f9d1d7cc4b47609846deeea26c04bd3b2 Mon Sep 17 00:00:00 2001 From: Alexander Voss Date: Thu, 2 Nov 2023 10:52:33 +0000 Subject: [PATCH] Documentation (#6267) * added short description + links to MkDocs docu * hopefully better wording --- docs/publishing-your-site.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/publishing-your-site.md b/docs/publishing-your-site.md index a33ac968576..37a50346d48 100644 --- a/docs/publishing-your-site.md +++ b/docs/publishing-your-site.md @@ -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