.This Vite plugin adds assistance for importing a Fall file as a Vue component. Works with Vue 2 & 3.Vue.js Demonstration Blocks.Leave your Vue.js code blocks inline through simply including trial next to the language name.For instance, when this Markdown file is provided through this plugin, you'll view a clickable switch right here:."' vue demo.
Click me."'( end).Set up.npm set up -D vite-vue-md.Create.In your vite.config.js data:.Import vite-vue-md and also add it to the plugins variety.In your vue() plugin possibilities, add a consist of alternative that includes.md data.vite.config.js:.bring in vue coming from '@vitejs/ plugin-vue'.+ import vueMd from 'vite-vue-md'.export nonpayment plugins: [// ...vue( + feature: [/. vue$/,/ . md$/]// u2190 Deal with MD files as Vue elements. ),.+ vueMd(/ * Options */)// u2190 Put together MD files to Vue components.]// ...To compile a Vue.js codeblock as a Demo Block, include demo beside the foreign language label:."' vue demonstration.
Click me."'( end).Multi-file demonstrations.The admittance aim for demo blocks need to be actually a Vue.js component. But you can import various other code blocks out in any language coming from the same Markdown file.For non-entry data, set a data title by means of trial=. At that point import it coming from the Vue.js trial block through the doc: process:.
Click me.
Second file:.demo= click-handler. js.export const clickHandler = () => sharp(' Clicked!').Trial + Code obstructs.Since the code blocks are rendered inline, they're substituted due to the actual Vue.js component. To reveal the code block, you can easily add a onDemo callback to the plugin possibilities:.( onDemo( componentTag, code) // Sign up the cover part.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Come back a custom-made HTML strand.profit '.$ componentTag
$ this.escapeHtml( code)'. ).Alternatives.consist of.Kind: ReadonlyArray|string|RegExp.Data to include from being actually organized as Vue data.leave out.Style: ReadonlyArray|string|RegExp.Documents to omit coming from being actually assembled as Vue documents.markdownItOptions.Type: markdownIt.Options.MarkdownIt choices. Check out MarkdownIt's documentation to learn more.markdownItSetup.Type: (md: markdownIt) => void.Callback to include plugins to MarkdownIt.wrapperClass.Type: string.Default: markdown-body.The training class to contribute to the cover element that contains the Fall page.onDemo.Kind:.(.tag: string,.code: strand,.demonstrations: Map.) => strand.You may obstruct each trial block and come back a custom HTML strand. This works for incorporating custom-made styling to demonstration blocks.In addition, there are utils left open in the this situation:.escapeHtml: Breaking away HTML code to prevent it from being provided as HTML.registerComponent: Register a component to become made use of in the demo block. This serves for registering parts that are actually imported coming from other documents.Observe instance above in the Demo Blocks segment.markdownCss.Kind: chain.File path to a stylesheet to make use of for the Fall web page. This will definitely be actually incorporated making use of so it will only apply to the markdown page. Beneficial for designating just the HTML created due to the MarkdownIt plugin.useVOnce.Type: boolean.Whether to incorporate v-once to the whole entire Fall web page. This will definitely avoid the Fall page from being actually re-rendered when the Vue element is actually upgraded.Warning: This will certainly disable trial blocks. Just utilize this if you have a large record and don't require demonstration blocks.Related.unplugin-vue-markdown.One more Vite plugin for collecting Accounting allowance data to Vue parts.This plugin has actually pulled ideas from it however has a various component collection. This plugin just sustains Vue.js code in code blocks.Github.View Github.