OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Documentation (#6267)

Browse Source 
* added short description + links to MkDocs docu

* hopefully better wording
This commit is contained in:
Alexander Voss 2023-11-02 10:52:33 +00:00 committed by GitHub
parent 7353c7d7cf
commit 9a7a185f9d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/publishing-your-site.md
View File

@ -142,6 +142,14 @@ the following command from the directory containing the `mkdocs.yml` file:
mkdocs gh-deploy --force 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 ## GitLab Pages
If you're hosting your code on GitLab, deploying to [GitLab Pages] can be done If you're hosting your code on GitLab, deploying to [GitLab Pages] can be done