社交媒体卡片图片#

此插件将自动生成一张 PNG 图片,用于在社交媒体平台上分享文档链接。这些卡片显示您所链接页面的元数据,旨在吸引读者的注意力。

opengraph.xyz 上查看您的社交媒体卡片预览。这是此页面的卡片示例:

_images/num_0.png

禁用卡片图片#

禁用此插件的社交媒体卡片图片:

conf.py#
ogp_social_cards = {
    "enable": False
}

更新顶部右侧图片#

默认情况下,顶部右侧的图片将使用 html_logo 指定的图片。要更新它,请在 image 键中指定另一个路径:

conf.py#
ogp_social_cards = {
    "image": "path/to/image.png",
}

图片不能是 SVG 图片。

Matplotlib 不支持直接绘制 SVG 图片,因此请确保您的图片是 PNG 或 JPEG 图片,而不是 SVG。

自定义文字字体#

默认情况下,Roboto Flex 字体用于渲染卡片文本。

您可以通过 font 键指定其他字体名称:

conf.py#
ogp_social_cards = {
    "font": "Noto Sans CJK JP",
}

您可能需要在您的环境中安装额外的字体包。此外,请注意字体名称需要能被 Matplotlib 的 FontManager 识别。有关 FontManager 的信息,请参阅 Matplotlib 文档

定制卡片#

下面是一些定制选项,用于更改社交媒体预览卡片的文本和外观。下面是这些选项的摘要。

  • site_url: 设置自定义站点 URL。

  • line_color: 卡片底部边框线的颜色,以十六进制格式表示。

示例社交媒体卡片#

下面是一些社交媒体卡片,以展示此扩展在不同长度和大小的文本下的行为。

_images/num_0.png
_images/num_1.png
_images/num_2.png
_images/num_3.png
_images/num_4.png
_images/num_5.png
_images/num_6.png
_images/num_7.png
_images/num_8.png
_images/num_9.png
_images/num_10.png
_images/num_11.png
_images/num_12.png
_images/num_13.png
_images/num_14.png
_images/num_15.png
_images/num_16.png
_images/num_17.png
_images/num_18.png
_images/num_19.png