Commit fde981e
committed
fix: silence mkdocs social plugin warnings in strict mode
The social plugin (`mkdocs-material`) requires cairosvg for generating
Open Graph social card images. This dependency was never included in the
docs dependency group, so the plugin emitted a warning on every page.
With strict mode enabled, these warnings aborted the build.
Changes:
- Add `mkdocs-material[imaging]` extra to the docs dependency group,
which pulls in `cairosvg`, `cairocffi`, `cssselect2`, `defusedxml`,
and `tinycss2`. This requires the system Cairo library (`libcairo2`),
which is pre-installed on GitHub Actions ubuntu-latest runners.
- Gate the social plugin behind an `ENABLE_SOCIAL_CARDS` env var
(defaults to false) so local development does not require Cairo.
- Set `ENABLE_SOCIAL_CARDS=true` in the docs publish workflow so social
cards are generated for the published site.1 parent c032854 commit fde981e
File tree
4 files changed
+87
-7
lines changed- .github/workflows
4 files changed
+87
-7
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
31 | 31 | | |
32 | 32 | | |
33 | 33 | | |
| 34 | + | |
| 35 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
112 | 112 | | |
113 | 113 | | |
114 | 114 | | |
115 | | - | |
| 115 | + | |
| 116 | + | |
116 | 117 | | |
117 | 118 | | |
118 | 119 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
75 | 75 | | |
76 | 76 | | |
77 | 77 | | |
78 | | - | |
| 78 | + | |
79 | 79 | | |
80 | 80 | | |
81 | 81 | | |
| |||
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
0 commit comments