docs: add details abut integration with social cards plugin

Guts · Dec 16, 2023 · fb2d8d4 · fb2d8d4
1 parent 77c2845
commit fb2d8d4
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -439,5 +439,7 @@ If `false`, the integration with Social Cards is disabled.
 
 Default: `true`.
 
+> See [the related section in integrations page](./integrations.md#social-cards-plugin-from-material-theme).
+
 <!-- Hyperlinks reference -->
 [page metadata]: https://python-markdown.github.io/extensions/meta_data/
diff --git a/docs/integrations.md b/docs/integrations.md
@@ -3,6 +3,22 @@ title: Integrations
 icon: octicons/plug-16
 ---
 
+## Social Cards plugin (from Material theme)
+
+Since version 1.10, the plugin integrates with the [Social Cards plugin (shipped with Material theme)](https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/) (see also [the full plugin documentation here](https://squidfunk.github.io/mkdocs-material/plugins/social/)).
+
+Here's how the RSS plugin prioritizes the image to be used in the feed:
+
+1. an image (local path or URL) is defined in the page's YAML header of the page with the key `image`. Typically: `image: path_or_url_to_image.webp`.
+1. an image (local path or URL) is defined in the page's YAML header with the key `illustration`. Typically: `illustration: path_or_url_to_image.webp`.
+1. if neither is defined, but both the social plugin and the cards option are enabled, then the social card image is used.
+
+If you don't want this integration, you can disable it with the option: `use_material_social_cards=false`.
+
+> See [related section in settings](./configuration.md#use_material_social_cards-enabledisable-integration-with-material-social-cards-plugin).
+
+----
+
 ## Reference RSS feeds in HTML meta-tags
 
 To facilitate the discovery of RSS feeds, it's recommended to add relevant meta-tags in `<head>` section in HTML pages.