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

Documentation

Browse Source
This commit is contained in:
squidfunk 2022-09-15 19:02:13 +02:00
parent 5afacad66c
commit 15d9dacc0c
4 changed files with 15 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Dockerfile
View File

@ -61,7 +61,9 @@ RUN \
if [ "${WITH_PLUGINS}" = "true" ]; then \ if [ "${WITH_PLUGINS}" = "true" ]; then \
pip install --no-cache-dir \ pip install --no-cache-dir \
"mkdocs-minify-plugin>=0.3" \ "mkdocs-minify-plugin>=0.3" \
"mkdocs-redirects>=1.0"; \ "mkdocs-redirects>=1.0" \
"pillow>=9.0" \
"cairosvg>=2.5"; \
fi \ fi \
&& \ && \
apk del .build \ apk del .build \

17
docs/setup/setting-up-social-cards.md
View File

@ -118,15 +118,18 @@ The following configuration options are available:
#### Dependencies #### Dependencies
Two Python packages are installed alongside Material for MkDocs to generate the Two Python libraries must be installed alongside Material for MkDocs to generate
social preview images, both of which are based on the [Cairo Graphics] library: 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 Both libraries are built with native extensions which need to be installed as
you don't want to use Docker, see the following section which explains how to well. The [Docker image] comes with all dependencies pre-installed. If you don't
install all dependencies on your system: want to use Docker, see the following section which explains how to install all
dependencies on your system:
=== ":material-apple: macOS" === ":material-apple: macOS"

2
material/plugins/social/plugin.py
View File

@ -70,7 +70,7 @@ class SocialPlugin(BasePlugin):
if not dependencies: if not dependencies:
log.error( log.error(
"Required dependencies of \"social\" plugin not found. " "Required dependencies of \"social\" plugin not found. "
"Install with: pip install cairosvg pillow" "Install with: pip install pillow cairosvg"
) )
sys.exit() sys.exit()

2
src/plugins/social/plugin.py
View File

@ -70,7 +70,7 @@ class SocialPlugin(BasePlugin):
if not dependencies: if not dependencies:
log.error( log.error(
"Required dependencies of \"social\" plugin not found. " "Required dependencies of \"social\" plugin not found. "
"Install with: pip install cairosvg pillow" "Install with: pip install pillow cairosvg"
) )
sys.exit() sys.exit()