mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-06-14 11:52:32 +03:00
Documentation (#6267)
* added short description + links to MkDocs docu * hopefully better wording
This commit is contained in:
parent
7353c7d7cf
commit
9a7a185f9d
@ -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
|
||||
|
Loading…
Reference in New Issue
Block a user