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

added user-provided docs for container packaging

Browse Source
This commit is contained in:
Roman Dodin 2023-06-21 18:38:05 +03:00
parent b38e6a7cbf
commit aec897302f
No known key found for this signature in database
2 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/getting-started.md
View File

@ -117,11 +117,12 @@ The following plugins are bundled with the Docker image:
Material for MkDocs only bundles selected plugins in order to keep the size 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, of the official image small. If the plugin you want to use is not included,
create a new `Dockerfile` and extend the official Docker image: create a `user-requirements.txt` file in the repository root with the packages
you want to install additionally, e.g.:
``` Dockerfile ``` txt title="user-requirements.txt"
FROM squidfunk/mkdocs-material mkdocs-macros-plugin==0.7.0
RUN pip install ... mkdocs-glightbox>=0.3.1
``` ```
Next, you can build the image with the following command: Next, you can build the image with the following command:
@ -130,7 +131,8 @@ The following plugins are bundled with the Docker image:
docker build -t squidfunk/mkdocs-material . docker build -t squidfunk/mkdocs-material .
``` ```
The new image can be used exactly like the official image. The new image will have additional packages installed and can be used
exactly like the official image.
### with git ### with git

3
docs/insiders/getting-started.md
View File

@ -79,6 +79,9 @@ docker login -u ${GH_USERNAME} -p ${GHCR_TOKEN} ghcr.io
docker pull ghcr.io/${GH_USERNAME}/mkdocs-material-insiders docker pull ghcr.io/${GH_USERNAME}/mkdocs-material-insiders
``` ```
Should you wish to add additional plugins to the insiders container image, follow the steps
outlined in the [Getting Started guide](../getting-started.md#with-docker).
[^2]: [^2]:
Earlier, Insiders provided a dedicated Docker image which was available to Earlier, Insiders provided a dedicated Docker image which was available to
all sponsors. On March 21, 2021, the image was deprecated for the reasons all sponsors. On March 21, 2021, the image was deprecated for the reasons