Cool_Tools/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-11-12 01:50:52 +01:00
Code Issues Releases Wiki Activity

Added list of bundled plugins

Browse Source
This commit is contained in:
squidfunk 2020-07-27 12:41:04 +02:00
parent cf037cfccf
commit 8bc24aa03e
2 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Dockerfile
View File

@ -40,10 +40,10 @@ RUN \
&& apk add --no-cache --virtual .build gcc musl-dev \ && apk add --no-cache --virtual .build gcc musl-dev \
&& pip install --no-cache-dir . \ && pip install --no-cache-dir . \
&& pip install --no-cache-dir \ && pip install --no-cache-dir \
'mkdocs-awesome-pages-plugin>=2.2.1' \
'mkdocs-git-revision-date-localized-plugin>=0.4' \
'mkdocs-minify-plugin>=0.3' \ 'mkdocs-minify-plugin>=0.3' \
'mkdocs-redirects>=1.0' \ 'mkdocs-redirects>=1.0' \
'mkdocs-git-revision-date-localized-plugin>=0.4' \
'mkdocs-awesome-pages-plugin>=2.2.1' \
&& apk del .build gcc musl-dev \ && apk del .build gcc musl-dev \
&& rm -rf /tmp/* && rm -rf /tmp/*

15
docs/getting-started.md
View File

@ -65,11 +65,22 @@ The `mkdocs` executable is provided as an entry point and `serve` is the
default command. If you're not familiar with Docker don't worry, we have you default command. If you're not familiar with Docker don't worry, we have you
covered in the following sections. covered in the following sections.
The following plugins are bundled with the Docker image:
* [mkdocs-awesome-pages-plugin][12]
* [mkdocs-git-revision-date-localized-plugin][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
[13]: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin
[14]: https://github.com/byrnereese/mkdocs-minify-plugin
[15]: https://github.com/datarobot/mkdocs-redirects
### with git ### with git
Material for MkDocs can be directly used from [GitHub][12] by cloning the Material for MkDocs can be directly used from [GitHub][16] 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:
@ -95,4 +106,4 @@ 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].
[12]: https://github.com/squidfunk/mkdocs-material [16]: https://github.com/squidfunk/mkdocs-material