1.0.0 • Published 5 months ago
@mdit-kdu/plugin-sfc v1.0.0
@mdit-kdu/plugin-sfc
A markdown-it plugin to help transforming markdown to Kdu 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-kdu/plugin-sfc
Usage
This plugin will only take effects when the html
option of markdown-it is enabled:
import MarkdownIt from 'markdown-it';
import { sfcPlugin } from '@mdit-kdu/plugin-sfc';
import type { MarkdownItEnv } from '@mdit-kdu/types';
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.
1.0.0
5 months ago