mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-11-23 23:21:00 +01:00
Documentation
This commit is contained in:
parent
5afacad66c
commit
15d9dacc0c
@ -61,7 +61,9 @@ RUN \
|
||||
if [ "${WITH_PLUGINS}" = "true" ]; then \
|
||||
pip install --no-cache-dir \
|
||||
"mkdocs-minify-plugin>=0.3" \
|
||||
"mkdocs-redirects>=1.0"; \
|
||||
"mkdocs-redirects>=1.0" \
|
||||
"pillow>=9.0" \
|
||||
"cairosvg>=2.5"; \
|
||||
fi \
|
||||
&& \
|
||||
apk del .build \
|
||||
|
@ -118,15 +118,18 @@ The following configuration options are available:
|
||||
|
||||
#### Dependencies
|
||||
|
||||
Two Python packages are installed alongside Material for MkDocs to generate the
|
||||
social preview images, both of which are based on the [Cairo Graphics] library:
|
||||
Two Python libraries must be installed alongside Material for MkDocs to generate
|
||||
the social preview images, both of which are based on [Cairo Graphics] –
|
||||
[Pillow] and [CairoSVG]:
|
||||
|
||||
- [Pillow] – Python imaging library
|
||||
- [CairoSVG] – Converter for `*.svg` files
|
||||
```
|
||||
pip install pillow cairosvg
|
||||
```
|
||||
|
||||
The [Docker image] comes with all dependencies pre-installed. If
|
||||
you don't want to use Docker, see the following section which explains how to
|
||||
install all dependencies on your system:
|
||||
Both libraries are built with native extensions which need to be installed as
|
||||
well. The [Docker image] comes with all dependencies pre-installed. If you don't
|
||||
want to use Docker, see the following section which explains how to install all
|
||||
dependencies on your system:
|
||||
|
||||
=== ":material-apple: macOS"
|
||||
|
||||
|
@ -70,7 +70,7 @@ class SocialPlugin(BasePlugin):
|
||||
if not dependencies:
|
||||
log.error(
|
||||
"Required dependencies of \"social\" plugin not found. "
|
||||
"Install with: pip install cairosvg pillow"
|
||||
"Install with: pip install pillow cairosvg"
|
||||
)
|
||||
sys.exit()
|
||||
|
||||
|
@ -70,7 +70,7 @@ class SocialPlugin(BasePlugin):
|
||||
if not dependencies:
|
||||
log.error(
|
||||
"Required dependencies of \"social\" plugin not found. "
|
||||
"Install with: pip install cairosvg pillow"
|
||||
"Install with: pip install pillow cairosvg"
|
||||
)
|
||||
sys.exit()
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user