该插件用于生成HTML head
中的元数据描述、RSS Feed中的摘要,以及在文件夹与标签列表中当正文内容为空时,作为标题与列表之间的说明文本。
如果文档的frontmatter中包含description
属性,则优先使用该属性(参见语法)。否则,插件会自动截取内容的前几句话生成描述,使其接近目标长度。
Note
关于如何添加、移除或配置插件,请参阅配置页面。
本插件接受以下配置选项:
descriptionLength
: 生成描述的最大长度。默认150个字符。截断发生在第一个超过该长度的完整句子结尾处。replaceExternalLinks
: 若为true
(默认值),在描述中将外部链接替换为其域名和路径(例如https://domain.tld/some_page/another_page?query=hello&target=world
会被替换为domain.tld/some_page/another_page
)。
API
- 类别:转换器
- 函数名称:
Plugin.Description()
- 源码:
quartz/plugins/transformers/description.ts