OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Documentation

Browse Source
This commit is contained in:
squidfunk 2023-08-19 14:42:44 +02:00
parent 914df5fe70
commit 0a7e9d21bd
No known key found for this signature in database
GPG Key ID: 5ED40BC4F9C436DF
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -66,6 +66,20 @@ plugins:
> generates images much more efficiently in parallel and allows to build > generates images much more efficiently in parallel and allows to build
> entirely [custom layouts]. > entirely [custom layouts].
!!! info "The [`site_url`][site_url] setting must be set"
Note that you must set [`site_url`][site_url] when using the social plugin,
or the generated cards will not be correctly linked. Social media services
like Twitter and Facebook demand that social previews point to an absolute
URL, which the plugin can only compute when [`site_url`][site_url] is set.
Example:
``` yaml
site_url: https://example.com
```
[site_url]: https://www.mkdocs.org/user-guide/configuration/#site_url
The following configuration options are available: The following configuration options are available:
[`enabled`](#+social.enabled){ #+social.enabled } [`enabled`](#+social.enabled){ #+social.enabled }