.This Vite plugin incorporates help for importing a Markdown data as a Vue component. Functions with Vue 2 & 3.Vue.js Demonstration Blocks.Leave your Vue.js code blocks out inline by simply including trial beside the language name.For instance, when this Markdown file is left through this plugin, you'll observe a clickable switch right here:."' vue demonstration.
Click me."'( end).Install.npm set up -D vite-vue-md.Create.In your vite.config.js report:.Bring in vite-vue-md and also include it to the plugins selection.In your vue() plugin choices, add an include option that includes.md documents.vite.config.js:.bring in vue coming from '@vitejs/ plugin-vue'.+ import vueMd coming from 'vite-vue-md'.export nonpayment plugins: [// ...vue( + feature: [/. vue$/,/ . md$/]// u2190 Address MD files as Vue components. ),.+ vueMd(/ * Options */)// u2190 Assemble MD reports to Vue components.]// ...To put together a Vue.js codeblock as a Trial Block, add trial close to the language label:."' vue demonstration.
Click me."'( end).Multi-file demonstrations.The admittance aim for trial blocks need to be actually a Vue.js component. Yet you may import various other code blocks out in any sort of language from the same Markdown file.For non-entry reports, placed a documents label via demonstration=. After that bring in it from the Vue.js trial block through the doc: method:.
Click me.
Second documents:.demo= click-handler. js.export const clickHandler = () => alert(' Clicked on!').Demonstration + Code obstructs.Considering that the code blocks are actually delivered inline, they're switched out by the real Vue.js element. To present the code block, you may incorporate a onDemo callback to the plugin alternatives:.( onDemo( componentTag, code) // Sign up the wrapper part.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Return a personalized HTML cord.gain '.$ componentTag
$ this.escapeHtml( code)'. ).Possibilities.feature.Type: ReadonlyArray|string|RegExp.Data to feature from being actually put together as Vue documents.leave out.Type: ReadonlyArray|string|RegExp.Data to exclude coming from being actually assembled as Vue documents.markdownItOptions.Style: markdownIt.Options.MarkdownIt alternatives. Visit MarkdownIt's documents for additional information.markdownItSetup.Kind: (md: markdownIt) => void.Callback to add plugins to MarkdownIt.wrapperClass.Type: strand.Default: markdown-body.The training class to add to the wrapper factor that contains the Fall page.onDemo.Style:.(.tag: string,.code: cord,.trials: Map.) => string.You may obstruct each demo block and return a custom-made HTML cord. This works for adding customized designing to demo blocks.Moreover, there are utils subjected in the this circumstance:.escapeHtml: Breaking away HTML code to avoid it coming from being left as HTML.registerComponent: Sign up an element to become used in the trial block. This is useful for signing up parts that are imported from various other files.See example over in the Demo Blocks segment.markdownCss.Kind: string.File course to a stylesheet to utilize for the Fall page. This will certainly be incorporated utilizing so it is going to merely apply to the accounting allowance webpage. Practical for designating merely the HTML produced by the MarkdownIt plugin.useVOnce.Type: boolean.Whether to incorporate v-once to the whole Fall webpage. This will definitely protect against the Accounting allowance web page from being re-rendered when the Vue component is actually improved.Caution: This will definitely disable trial blocks. Simply use this if you possess a big document as well as do not need to have trial blocks.Connected.unplugin-vue-markdown.Yet another Vite plugin for organizing Markdown documents to Vue elements.This plugin has pulled inspiration coming from it however has a various component set. This plugin just supports Vue.js code in code blocks.Github.Viewpoint Github.