markdown-it-vuese

自定义渲染

在文档中直接使用 Vuese 的默认渲染结果，可能无法适应全部的场景。

需求

不需要标题，并且想将 Props 等属性从 <h2> 改成 <h3>

配置

const md = require('markdown-it')()
    .use(require('markdown-it-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('')
        },
    })

文档

<[vuese-h3](@/test/MyComponent.vue)

提示

注意我们新增了一条 vuese 规则

结果

props

Name Description Type Required Default
name The name of the form, up to 8 characters String / Number true -

slots

Name Description Default Slot Content
header Form header <th>title</th>

events

Event Name Description Parameters
onclear Fire when the form is cleared The argument is a boolean value representing xxx

methods

Method Description Parameters
clear Used to manually clear the form -

←