2.1.2 • Published 19 days ago
@mdit-vue/plugin-sfc v2.1.2
@mdit-vue/plugin-sfc
A markdown-it plugin to help transforming markdown to Vue SFC.
- Avoids rendering
<script>
and<style>
tags and extract them into to markdown-itenv.sfcBlocks
. - Supports extracting custom blocks.
- Provides
env.sfcBlocks.template
for convenience.
Install
npm i @mdit-vue/plugin-sfc
Usage
This plugin will only take effects when the html
option of markdown-it is enabled:
import { sfcPlugin } from '@mdit-vue/plugin-sfc';
import type { MarkdownItEnv } from '@mdit-vue/types';
import MarkdownIt from 'markdown-it';
const md = MarkdownIt({ html: true }).use(sfcPlugin, {
// options
});
const env: MarkdownItEnv = {};
const rendered = md.render(
`\
# foo
<script>
console.log('bar')
</script>
`,
env,
);
console.log(env.sfcBlocks);
Options
customBlocks
Type:
string[]
Default:
[]
Details:
SFC custom blocks to be extracted.
By default, only
<script>
and<style>
tags will be extracted. You can set this option to support SFC custom blocks in markdown.For example, if you set this option to
['i18n']
, the<i18n>
tag in your markdown content will be extracted toenv.sfcBlocks.customBlocks
and won't appear in the rendered result.
2.1.2
19 days ago
2.1.0
27 days ago
2.0.0
5 months ago
1.0.0
7 months ago
0.12.1
8 months ago
0.12.0
1 year ago
0.10.0
2 years ago
0.11.0
2 years ago
0.11.1
2 years ago
0.9.2
2 years ago
0.9.1
2 years ago
0.9.0
2 years ago
0.8.0
2 years ago
0.7.1
2 years ago
0.7.0
2 years ago
0.6.0
2 years ago
0.5.0
2 years ago
0.4.0
2 years ago
0.3.0
2 years ago
0.2.0
2 years ago