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

Added documentation for installing plugins in the Docker image

Browse Source
This commit is contained in:
squidfunk 2020-09-16 11:30:05 +02:00
parent 9da3d25c07
commit e0b539996c
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/getting-started.md
View File

@ -78,6 +78,26 @@ The following plugins are bundled with the Docker image:
[14]: https://github.com/byrnereese/mkdocs-minify-plugin [14]: https://github.com/byrnereese/mkdocs-minify-plugin
[15]: https://github.com/datarobot/mkdocs-redirects [15]: https://github.com/datarobot/mkdocs-redirects
??? question "How can I add plugins to the Docker image?"
Material for MkDocs bundles useful and common plugins while trying not to
blow up the size of the official image. If the plugin you want to use is
not included, create a new `Dockerfile` and extend the official Docker image
with your custom installation routine:
``` Dockerfile
FROM squidfunk/mkdocs-material
RUN pip install ...
```
Next, you can build the image with the following command:
```
docker build -t squidfunk/mkdocs-material .
```
The new image can be used exactly like the official 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][16] by cloning the