1.0.1 • Published 5 months ago

vuepress-plugin-filterfunc v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
5 months ago

介绍

这是一个 vuepress 的插件,为 vuepress 用户提供了一个类似 eleventy 中 filter 函数的过滤器功能。

使用方法:

示例

// 在你的config.ts文件中
import { filterFuncConfig } from 'vuepress-plugin-filterfunc'
export default defineUserConfig({
  plugins: [
    filterFuncConfig({
      workDir: ['', 'ports/'],
      filterFuncs: {
        toLowerCase: (name) => {
          return name.toLowerCase()
        },
      },
    }),
  ],
})
## <!-- 在你的md文件中 -->

name | toLowerCase: FIRSTMEET

---

这个文件的 frontmatter 最终会被解析为 name: firstmeet

配置:

config.ts

{
  workDir: ['', 'ports/'], // 你的md文件所在的目录,用数组表示,如果你的md文件在/src目录下,那么就是[''],如果你的md文件在/src/ports目录下,那么就是['ports/']。
  filterFuncs: {
    // 过滤器函数,key是过滤器的名字,value是过滤器函数
    // 过滤器函数的参数val是你在md文件中使用过滤器时的属性值
    // 过滤器函数的返回值newVal会替换掉你在md文件中使用过滤器后的属性值。
    'funName':funtion(val){
      return newVal
    }
  }
}

md 中

---
name | fun: val
---

其中 fun 为你注册的过滤器函数的名字,val 为你传入的参数。
最终会被解析为 name: newVal

开发者

期待更多的需求,欢迎提 issue

1.0.1

5 months ago

1.0.0

5 months ago