启用OGP支持的Sphinx扩展
sphinxext-opengraph的Python项目详细描述
狮身人面像opengraph
生成OpenGraph元数据的Sphinx扩展(https://ogp.me/)
安装
python -m pip install sphinxext-opengraph
使用
只需将sphinxext.opengraph
添加到conf.py
中的扩展列表中
extensions=[sphinxext.opengraph,]
选项
这些值放在配置文件你的狮身人面像计划。在
ogp_site_url
- 此配置选项非常重要,请将其设置为网站所在的URL。在
ogp_description_length
- 配置从页面获取的字符量。默认值200对大多数人来说可能是好事。如果使用的不是数字,则默认为200。在
ogp_site_name
- 这不是必需的。站点的名称。它显示在标题上方。在
ogp_image
- 这不是必需的。链接到要显示的图像。在
ogp_image_alt
- 这不是必需的。图像的Alt文本。默认使用
ogp_site_name
或文档标题作为alt text(如果可用)。如果要完全关闭alt text,请设置为False
。在
- 这不是必需的。图像的Alt文本。默认使用
ogp_type
- 这将设置ogp type属性,有关可用类型的更多信息,请查看https://ogp.me/#types。默认情况下,它被设置为
website
,这对于大多数用例来说应该是合适的。在
- 这将设置ogp type属性,有关可用类型的更多信息,请查看https://ogp.me/#types。默认情况下,它被设置为
ogp_custom_meta_tags
- 这不是必需的。要插入的自定义html代码段列表。在
配置示例
简单配置
^{pr2}$高级配置
ogp_site_url="http://example.org/"ogp_image="http://example.org/image.png"ogp_description_length=300ogp_type="article"ogp_custom_meta_tags=['<meta property="og:ignore_canonical" content="true" />',]
- 项目
标签: