Skip to content

Commit 04b8d89

Browse files
committed
Documentation
1 parent a4c1b23 commit 04b8d89

File tree

1 file changed

+23
-8
lines changed

1 file changed

+23
-8
lines changed

docs/getting-started.md

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -123,16 +123,31 @@ The following plugins are bundled with the Docker image:
123123
??? question "How to add plugins to the Docker image?"
124124

125125
Material for MkDocs only bundles selected plugins in order to keep the size
126-
of the official image small. If the plugin you want to use is not included,
127-
create a `user-requirements.txt` file in the repository root with the packages
128-
you want to install additionally, e.g.:
126+
of the official image small. If the plugin you want to use is not included,
127+
you can add them easily:
129128

130-
``` txt title="user-requirements.txt"
131-
mkdocs-macros-plugin==0.7.0
132-
mkdocs-glightbox>=0.3.1
133-
```
129+
=== "Material for MkDocs"
130+
131+
Create a `Dockerfile` and extend the official image:
132+
133+
``` Dockerfile title="Dockerfile"
134+
FROM squidfunk/mkdocs-material
135+
RUN pip install mkdocs-macros-plugin
136+
RUN pip install mkdocs-glightbox
137+
```
138+
139+
=== "Insiders"
140+
141+
Clone or fork the Insiders repository, and create a file called
142+
`user-requirements.txt` in the root of the repository. Then, add the
143+
plugins that should be installed to the file, e.g.:
144+
145+
``` txt title="user-requirements.txt"
146+
mkdocs-macros-plugin
147+
mkdocs-glightbox
148+
```
134149

135-
Next, you can build the image with the following command:
150+
Next, build the image with the following command:
136151

137152
```
138153
docker build -t squidfunk/mkdocs-material .

0 commit comments

Comments
 (0)