Skip to content

Commit 2cea121

Browse files
committed
docs: add social image support
MkDocs material has a plugin to help create nice social previews. For more information, see: https://squidfunk.github.io/mkdocs-material/plugins/social/ Signed-off-by: JP-Ellis <[email protected]>
1 parent 94984f4 commit 2cea121

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ plugins:
5757
annotations_path: brief
5858
show_signature: true
5959
show_signature_annotations: true
60+
- social
6061

6162
markdown_extensions:
6263
# Python Markdown

pyproject.toml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -68,12 +68,12 @@ devel-types = [
6868
"types-requests ~=2.0",
6969
]
7070
devel-docs = [
71-
"mkdocs ~= 1.5",
72-
"mkdocs-material ~= 9.4",
73-
"mkdocs_gen_files ~= 0.5",
74-
"mkdocs-literate-nav ~= 0.6",
75-
"mkdocs-section-index ~= 0.3",
76-
"mkdocstrings[python] ~= 0.23",
71+
"mkdocs ~= 1.5",
72+
"mkdocs-material[imaging] ~= 9.4",
73+
"mkdocs_gen_files ~= 0.5",
74+
"mkdocs-literate-nav ~= 0.6",
75+
"mkdocs-section-index ~= 0.3",
76+
"mkdocstrings[python] ~= 0.23",
7777
]
7878
devel-test = [
7979
"aiohttp[speedups] ~=3.0",

0 commit comments

Comments
 (0)