mirror of
https://gitee.com/vant-contrib/vant.git
synced 2025-04-06 03:57:59 +08:00
25 lines
574 B
Markdown
25 lines
574 B
Markdown
# Vant Markdown Vetur
|
|
|
|
将 .md 文件转换成能描述 vue 组件的 .json 文件，供 vscode 插件 *vetur* 读取，从而可以在 vue 模版语法中拥有自动补全的功能。
|
|
|
|
## API
|
|
|
|
#### parseAndWrite
|
|
|
|
解析目录下所有匹配的文件，并输出为 tags.json 和 attributes.json
|
|
|
|
```ts
|
|
interface Options {
|
|
// 需要解析的文件夹路径
|
|
path: PathLike;
|
|
// 文件匹配正则
|
|
test: RegExp;
|
|
// 输出目录
|
|
outputDir: string;
|
|
// 递归的目录最大深度
|
|
maxDeep?: number;
|
|
// 解析出来的组件名前缀
|
|
tagPrefix?: string;
|
|
}
|
|
```
|