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

Updated getting started guide

Browse Source
This commit is contained in:
squidfunk 2020-09-27 12:24:56 +02:00
parent 080a4fc596
commit 674ab5ad3d
1 changed files with 11 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/getting-started.md
View File

@ -67,16 +67,12 @@ covered in the following sections.
The following plugins are bundled with the Docker image: The following plugins are bundled with the Docker image:
* [mkdocs-awesome-pages-plugin][12] * [mkdocs-minify-plugin][12]
* [mkdocs-git-revision-date-localized-plugin][13] * [mkdocs-redirects][13]
* [mkdocs-minify-plugin][14]
* [mkdocs-redirects][15]
[11]: https://hub.docker.com/r/squidfunk/mkdocs-material/ [11]: https://hub.docker.com/r/squidfunk/mkdocs-material/
[12]: https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin [12]: https://github.com/byrnereese/mkdocs-minify-plugin
[13]: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin [13]: https://github.com/datarobot/mkdocs-redirects
[14]: https://github.com/byrnereese/mkdocs-minify-plugin
[15]: https://github.com/datarobot/mkdocs-redirects
??? question "How can I add plugins to the Docker image?" ??? question "How can I add plugins to the Docker image?"
@ -100,7 +96,7 @@ The following plugins are bundled with the Docker image:
### with git ### with git
Material for MkDocs can be directly used from [GitHub][16] by cloning the Material for MkDocs can be directly used from [GitHub][14] by cloning the
repository into a subfolder of your project root which might be useful if you repository into a subfolder of your project root which might be useful if you
want to use the very latest version: want to use the very latest version:
@ -126,15 +122,15 @@ pip install -r mkdocs-material/requirements.txt
_Note that in order to install [Material for MkDocs Insiders][8], you'll _Note that in order to install [Material for MkDocs Insiders][8], you'll
need to [become a sponsor][9]._ need to [become a sponsor][9]._
[16]: https://github.com/squidfunk/mkdocs-material [14]: https://github.com/squidfunk/mkdocs-material
[^1]: [^1]:
In order to use `pip` to install from the private repository over HTTPS, the In order to use `pip` to install from the private repository over HTTPS, the
personal access token requires the [`repo`][17] scope. The creation and personal access token requires the [`repo`][15] scope. The creation and
usage of an access token is only necessary when installing Insiders over usage of an access token is only necessary when installing Insiders over
HTTPS, which is the recommended way when building from within a CI/CD HTTPS, which is the recommended way when building from within a CI/CD
workflow, e.g. using [GitHub Pages][18] or [GitLab Pages][19]. workflow, e.g. using [GitHub Pages][16] or [GitLab Pages][17].
[17]: https://docs.github.com/en/developers/apps/scopes-for-oauth-apps#available-scopes [15]: https://docs.github.com/en/developers/apps/scopes-for-oauth-apps#available-scopes
[18]: publishing-your-site.md#github-pages [16]: publishing-your-site.md#github-pages
[19]: publishing-your-site.md#gitlab-pages [17]: publishing-your-site.md#gitlab-pages