From 8bc24aa03e650dba8d12b98db6424aee46e8306d Mon Sep 17 00:00:00 2001 From: squidfunk Date: Mon, 27 Jul 2020 12:41:04 +0200 Subject: [PATCH] Added list of bundled plugins --- Dockerfile | 4 ++-- docs/getting-started.md | 15 +++++++++++++-- 2 files changed, 15 insertions(+), 4 deletions(-) diff --git a/Dockerfile b/Dockerfile index 23822ac6f..0857cf19c 100644 --- a/Dockerfile +++ b/Dockerfile @@ -40,10 +40,10 @@ RUN \ && apk add --no-cache --virtual .build gcc musl-dev \ && 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-redirects>=1.0' \ - 'mkdocs-git-revision-date-localized-plugin>=0.4' \ - 'mkdocs-awesome-pages-plugin>=2.2.1' \ && apk del .build gcc musl-dev \ && rm -rf /tmp/* diff --git a/docs/getting-started.md b/docs/getting-started.md index 22803e7c5..9a3750505 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -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 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/ + [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 -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 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 need to [become a sponsor][9]. - [12]: https://github.com/squidfunk/mkdocs-material + [16]: https://github.com/squidfunk/mkdocs-material