markdown-vetur/README.md

simple parse markdown to vue component description for vetur auto-completion

## 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;
}
```