markdown-vetur

simple parse markdown to vue component description for vetur auto-completion
9,030
Install
npm install markdown-vetur
Latest Version:0.0.5
License:MIT
Last Updated:Dec 10, 2018
Links: npm
Maintainer: zeusshuai

markdown-vetur 是什么

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

API

parseAndWrite

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

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

Related Packages

@cocoar/vue-markdown-core

Core markdown parsing utilities for @cocoar/vue-markdown

15,079 0
mdc-syntax

Markdown Component (MDC) parser with streaming support for Vue and React

16,532 1,072
markdown-it-mdc

Markdown Components (MDC) support for markdown-it

1,264,498 152
tree-sitter-vue

Vue grammar for tree-sitter

69,751 89
kokk

A beautiful way to create a documentation from markdown, and insert a vue compon...

10,142 49

Version History

Version Released License
0.0.5 MIT
0.0.4 MIT
0.0.3 MIT
0.0.2 MIT
0.0.1 MIT