mirror of https://gitee.com/vant-contrib/vant.git synced 2025-04-06 03:57:59 +08:00

History

feat(VantMarkdownVetur): support arguments of events (#10474 )

* feat(VantMarkdownVetur): support arguments of events

* fix(vant): fix mistake in readme

* docs(vant): fix '，' to ','

* fix(vant-markdown-vetur): support events arguments

* docs(AddressList): fix mistake

* docs(AddressList): prettier

* docs(Collapse): adjust

* docs(dropdown-menu): adjust

* docs(ImagePreview): adjust

* fix(vant-markdown-vetur): fix format

* fix(vant-markdown-vetur): fix formatter

2022-04-10 10:37:02 +08:00

src

feat(VantMarkdownVetur): support arguments of events (#10474 )

2022-04-10 10:37:02 +08:00

package.json

chore: update package.json, add repository and bugs (#10004 )

2021-12-06 16:37:48 +08:00

README.md

docs: install with pnpm (#9850 )

2021-11-12 17:49:53 +08:00

tsconfig.json

chore: extends base tsconfig (#9912 )

2021-11-23 10:14:54 +08:00

README.md

Vant Markdown Vetur

将 .md 文件转换成能描述 vue 组件的 .json 文件，供 WebStorm 和 vscode 的 vetur 插件读取，从而可以在 vue 模版语法中拥有自动补全的功能。

Install

# with npm
npm i @vant/markdown-vetur -D

# with yarn
yarn add @vant/markdown-vetur -D

# with pnpm
pnpm add @vant/markdown-vetur -D

API

parseAndWrite

解析目录下所有匹配的文件，并输出为 tags.json 和 attributes.json

interface Options {
  // 需要解析的文件夹路径
  path: PathLike;
  // 文件匹配正则
  test: RegExp;
  // 输出目录
  outputDir: string;
  // 递归的目录最大深度
  maxDeep?: number;
  // 解析出来的组件名前缀
  tagPrefix?: string;
}