English | 简体中文
Vuese plugin for markdown-it markdown parser.
With this plugin, you can use Vuese to automatically generate documents while importing existing *.vue files via following syntax.
<[vuese](@/filePath)The default value of @ is
process.cwd().
Please click here to see the demo
$ npm i -S markdown-it-vuese
# OR
$ yarn add markdown-it-vueseconst md = require('markdown-it')()
.use(require('markdown-it-vuese') [, options])const md = require('markdown-it')()
.use(require('markdown-it-vuese'), {
root: 'some path',
vueseRe: /your regexp/,
useParser: parserRes => parserRes.name,
useRender: (vueseRender) => {
const renderRes = vueseRender.render()
const markdownRes = vueseRender.renderMarkdown()
return 'something'
},
useAll: ({ ... }) => {
return 'something'
},
})- Type:
String - Default:
process.cwd()
Root Directory, this value will replace the @ in file path.
- Type:
RegExp - Default:
/<\[vuese\]\((.+)\)/i
Regular expression, you can customize it as you like.
- Type:
String - Default:
vuese
Rule name, it will be used by markdown-it, so be careful not to duplicate existing rules.
Use it with vueseRe, we can use different rules in the same document to render different results.
const vuese = require('markdown-it-vuese')
const md = require('markdown-it')()
// default
// <[vuese](filePath)
.use(vuese)
// <[vuese-h3](filePath)
// No title, `Props` and other attributes should be changed from `<h2>` to `<h3>`
.use(vuese, {
vueseRe: /<\[vuese-h3\]\((.+)\)/i,
ruleName: 'vuese-h3',
useRender: (vueseRender) => {
const renderRes = vueseRender.render()
const genMd = key => `### ${key}\n${renderRes[key]}\n`
return Object.keys(renderRes).map(genMd).join('')
},
})- Type:
Function - Default:
null
It takes @vuese/parser ParserResult as a parameter.
If useParser exists, it returns the result directly after running, otherwise try running useRender.
- Type:
Function - Default:
null
It takes @vuese/markdown-render Render Class as a parameter.
If useRender exists, it returns the result directly after running, otherwise try running useAll.
For example, you can call the following methods to generate objects and markdown documents, respectively.
render: will generaterenderResrenderMarkdown: will generatemarkdownRes
- Type:
Function - Default:
null
It takes an object as parameters with there attributes: content(source file content), parserRes, renderRes, markdownRes.
Return markdownRes.content by default, if useAll does not exist.
const md = require('markdown-it')()
.use(require('markdown-it-vuese'), {
useAll: ({
content,
parserRes,
renderRes,
markdownRes,
}) => {
return 'something'
},
})- Type:
Object - Default:
{}
It passes @vuese/parser options
- Type:
Object - Default:
{}
It passes @vuese/markdown-render options
Copyright (c) StEve Young
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent