Front-matter 是文件最上方包裹在 <!--
与 -->
之间的区域,用于指定个别文件的变量,举例来说:
<!--abbrlink: 290a4219tags: ['customTag1', 'customTag2']-->
以下是预先定义的参数,您可在模板中使用这些参数值并加以利用。
参数 | 描述 | 类型 |
---|---|---|
abbrlink | 短链。用于指定页面路由展示为指定短链,使用短链有助于 SEO 搜索。 | |
tags | 自定义标签 | string[] |
在以下场景需求场合中,可以展示短链以优化 URL 的显示。
在 config.yml
增加配置 abbrlink: true
+ abbrlink: true
做好上述配置后,接着在控制台执行 react-doc generate
即可给 menu 配置属性中的所有文章目录文件加上短链资源。
react-doc generate // 一键给所有文章加上短链