You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Sharing a docs link anywhere (Slack, a tweet, a PR comment) produces a bare URL with no preview. mkdocs-material can generate an Open Graph card per page from the page title and description.
What to do:
Add the social plugin to mkdocs.yml.
Switch docs-requirements.txt to mkdocs-material[imaging].
Install the system dependencies in .github/workflows/docs.yml. This is the part that will bite you: the imaging extra needs cairo and pango, so the workflow needs an apt-get install libcairo2-dev libfreetype6-dev libffi-dev libjpeg-dev libpng-dev libz-dev step before pip install. Without it the build fails with a cairo import error.
Add a favicon while you are in there.
Acceptance:
mkdocs build --strict produces site/assets/images/social/ with one image per page.
The docs workflow passes on a PR, which is where the system-dependency step gets proven.
Pasting a docs URL into a preview renderer shows a title card.
Comment here to claim it and a maintainer will assign it.
Activity