mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-06-14 11:52:32 +03:00
Documentation
This commit is contained in:
parent
a4c1b23912
commit
04b8d89baa
@ -123,16 +123,31 @@ The following plugins are bundled with the Docker image:
|
||||
??? question "How to add plugins to the Docker image?"
|
||||
|
||||
Material for MkDocs only bundles selected plugins in order to keep the size
|
||||
of the official image small. If the plugin you want to use is not included,
|
||||
create a `user-requirements.txt` file in the repository root with the packages
|
||||
you want to install additionally, e.g.:
|
||||
of the official image small. If the plugin you want to use is not included,
|
||||
you can add them easily:
|
||||
|
||||
``` txt title="user-requirements.txt"
|
||||
mkdocs-macros-plugin==0.7.0
|
||||
mkdocs-glightbox>=0.3.1
|
||||
```
|
||||
=== "Material for MkDocs"
|
||||
|
||||
Next, you can build the image with the following command:
|
||||
Create a `Dockerfile` and extend the official image:
|
||||
|
||||
``` Dockerfile title="Dockerfile"
|
||||
FROM squidfunk/mkdocs-material
|
||||
RUN pip install mkdocs-macros-plugin
|
||||
RUN pip install mkdocs-glightbox
|
||||
```
|
||||
|
||||
=== "Insiders"
|
||||
|
||||
Clone or fork the Insiders repository, and create a file called
|
||||
`user-requirements.txt` in the root of the repository. Then, add the
|
||||
plugins that should be installed to the file, e.g.:
|
||||
|
||||
``` txt title="user-requirements.txt"
|
||||
mkdocs-macros-plugin
|
||||
mkdocs-glightbox
|
||||
```
|
||||
|
||||
Next, build the image with the following command:
|
||||
|
||||
```
|
||||
docker build -t squidfunk/mkdocs-material .
|
||||
|
Loading…
Reference in New Issue
Block a user