Skip to content

Commit

Permalink
Added documentation for third-party Docker image
Browse files Browse the repository at this point in the history
  • Loading branch information
squidfunk committed Sep 19, 2021
1 parent 96cc7b6 commit ea130d1
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,22 @@ The following plugins are bundled with the Docker 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

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
want to use the very latest version:

Expand All @@ -96,4 +109,4 @@ from `git`, you must install all required dependencies yourself:
pip install -r mkdocs-material/requirements.txt
```

[11]: https://github.com/squidfunk/mkdocs-material
[12]: https://github.com/squidfunk/mkdocs-material

0 comments on commit ea130d1

Please sign in to comment.