启用OGP支持的Sphinx扩展

sphinxext-opengraph的Python项目详细描述


狮身人面像opengraph

BuildCode style: black

生成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。在
  • ogp_type
    • 这将设置ogp type属性,有关可用类型的更多信息,请查看https://ogp.me/#types。默认情况下,它被设置为website,这对于大多数用例来说应该是合适的。在
  • 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" />',]

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java为什么整数构造函数方法不再需要属性?   java单函数从广播接收器检索数据   Java类中的Scala设置器和获取器   JAVA MVC表选择的行ID和mysql db ID不同   java在Multimaps Guava中获取值   jakarta ee Intellij IDEA Java类在保存时不自动编译   java在另一个Spring实体中使用Spring实体   JTwitter库的安卓类一直在给我java。朗朗:温特韦尔。杰特维特。啁啾   java停止启动应用程序   java Jersey测试NoSuchMethodError   java如何处理合成元素上的注释   java崩溃shell无法通过ssh连接   java计算两个日期之间的天数后(取自edittext)如何在新的edittext中显示天数