@kaokei/vuepress-plugin-frontmatter
v1.0.2
Published
[email protected]插件,基于vdoing的主题,增加可以自动化生成frontmatter的命令
Downloads
2
Maintainers
Readme
@kaokei/vuepress-plugin-frontmatter
[email protected] 的插件,增加了
vuepress fmt docs
的命令,可以方便自动化生成 frontmatter 头部数据。
Install
npm install -D @kaokei/vuepress-plugin-frontmatter
Usage
module.exports = {
plugins: ["@kaokei/vuepress-plugin-frontmatter"],
};
需要在项目的 package.json 文件的 scripts 部分新增
"fmt": "vuepress fmt docs",
当新建一个新的 markdown 文件时,默认是一个空文件,当然也没有frontmatter
,此时可以执行命令npm run fmt
之所以增加这个命令,是因为vdoing
主题默认只支持npm run dev
和npm run build
这两个命令可以自动生成frontmatter
除了增加了上面的命令以外,还做了永久链接的重复检查,如果存在重复的永久链接,会在终端进行提示。
其他
需要注意本插件是基于 vdoing 主题的。除了新增加了 frontmatter 的命令。
还增加了一个功能就是默认_posts
文件夹下的所有文件的frontmatter
的showSidebar
属性默认为false
。
注意showSidebar
属性是一个新增的 vdoing 主题特有的属性,不是 vuepress 原本就支持的属性。
主要是为了解决这样的问题。当 sidebar=false 时,虽然不会显示左侧 sidebar,但是也会导致不现实rightMenu
。
但是showSidebar=false
时,仍然可以显示右侧rightMenu
。