.This Vite plugin incorporates assistance for importing a Markdown file as a Vue component. Works with Vue 2 & 3.Vue.js Trial Blocks.Render your Vue.js code shuts out inline by simply incorporating trial close to the foreign language name.For example, when this Markdown data is actually left using this plugin, you'll find a clickable switch here:."' vue demo.
Click me."'( end).Mount.npm put up -D vite-vue-md.Create.In your vite.config.js documents:.Bring in vite-vue-md and also incorporate it to the plugins range.In your vue() plugin alternatives, add a feature possibility that includes.md files.vite.config.js:.bring in vue from '@vitejs/ plugin-vue'.+ import vueMd coming from 'vite-vue-md'.export default plugins: [// ...vue( + include: [/. vue$/,/ . md$/]// u2190 Manage MD data as Vue elements. ),.+ vueMd(/ * Options */)// u2190 Compile MD reports to Vue parts.]// ...To assemble a Vue.js codeblock as a Demonstration Block, add trial beside the foreign language label:."' vue trial.
Click me."'( end).Multi-file demonstrations.The access purpose for trial blocks need to be actually a Vue.js part. Yet you can import various other code obstructs in any sort of language coming from the very same Markdown data.For non-entry reports, established a file label through trial=. After that bring in it coming from the Vue.js demo block through the doctor: protocol:.
Click me.
2nd file:.demo= click-handler. js.export const clickHandler = () => sharp(' Clicked!').Trial + Code obstructs.Since the code blocks are actually rendered inline, they're changed due to the actual Vue.js element. To present the code block, you can easily include a onDemo callback to the plugin choices:.( onDemo( componentTag, code) // Sign up the wrapper element.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Return a custom HTML string.yield '.$ componentTag
$ this.escapeHtml( code)'. ).Alternatives.feature.Kind: ReadonlyArray|string|RegExp.Reports to feature coming from being put together as Vue files.omit.Kind: ReadonlyArray|chain|RegExp.Reports to leave out from being actually collected as Vue data.markdownItOptions.Kind: markdownIt.Options.MarkdownIt possibilities. Go to MarkdownIt's information to find out more.markdownItSetup.Kind: (md: markdownIt) => gap.Callback to incorporate plugins to MarkdownIt.wrapperClass.Type: strand.Default: markdown-body.The class to include in the wrapper aspect that contains the Fall web page.onDemo.Kind:.(.tag: string,.code: cord,.demos: Map.) => string.You can obstruct each demonstration block and also come back a customized HTML cord. This is useful for adding customized designing to trial blocks.Furthermore, there are actually utils revealed in the this circumstance:.escapeHtml: Breaking away HTML code to stop it from being rendered as HTML.registerComponent: Sign up a component to become made use of in the demonstration block. This serves for signing up parts that are imported from various other documents.View example over in the Demonstration Blocks segment.markdownCss.Kind: chain.File road to a stylesheet to utilize for the Markdown web page. This will certainly be included utilizing so it is going to only relate to the accounting allowance web page. Valuable for styling only the HTML produced by the MarkdownIt plugin.useVOnce.Type: boolean.Whether to add v-once to the entire Accounting allowance webpage. This are going to stop the Accounting allowance webpage from being actually re-rendered when the Vue part is actually improved.Warning: This will definitely disable trial blocks. Merely use this if you have a sizable document and also don't need to have demo blocks.Connected.unplugin-vue-markdown.Yet another Vite plugin for assembling Accounting allowance files to Vue parts.This plugin has pulled motivation from it however possesses a different attribute set. This plugin only supports Vue.js code in code blocks.Github.Sight Github.