OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Added documentation for third-party Docker image

Browse Source
This commit is contained in:
squidfunk 2021-09-19 18:34:26 +02:00
parent 96cc7b6769
commit ea130d1f31
1 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/getting-started.md
View File

@ -79,9 +79,22 @@ The following plugins are bundled with the Docker image:
The new image can be used exactly like the official image. The new image can be used exactly like the official image.
!!! info ":material-apple: Apple Silicon (M1) and :fontawesome-brands-raspberry-pi: Raspberry Pi"
The official Docker image is only available for `linux/amd64`. We recommend
the [third-party image][11] by @afritzler if you want to run Material for
MkDocs via Docker on `arm64` or `armv7`, as it is automatically built on
every release:
```
docker pull ghcr.io/afritzler/mkdocs-material
```
[11]: https://github.com/afritzler/mkdocs-material
### with git ### with git
Material for MkDocs can be directly used from [GitHub][11] by cloning the Material for MkDocs can be directly used from [GitHub][12] by cloning the
repository into a subfolder of your project root which might be useful if you repository into a subfolder of your project root which might be useful if you
want to use the very latest version: want to use the very latest version:
@ -96,4 +109,4 @@ from `git`, you must install all required dependencies yourself:
pip install -r mkdocs-material/requirements.txt pip install -r mkdocs-material/requirements.txt
``` ```
[11]: https://github.com/squidfunk/mkdocs-material [12]: https://github.com/squidfunk/mkdocs-material