.This Vite plugin includes assistance for importing a Markdown file as a Vue part. Works along with Vue 2 & 3.Vue.js Trial Blocks.Leave your Vue.js code blocks inline through merely incorporating trial close to the language label.For instance, when this Markdown report is rendered using this plugin, you'll observe a clickable switch below:."' vue demonstration.
Click me."'( end).Mount.npm put up -D vite-vue-md.Create.In your vite.config.js file:.Bring in vite-vue-md and include it to the plugins array.In your vue() plugin possibilities, incorporate a feature option that includes.md files.vite.config.js:.import vue coming from '@vitejs/ plugin-vue'.+ import vueMd coming from 'vite-vue-md'.export nonpayment plugins: [// ...vue( + feature: [/. vue$/,/ . md$/]// u2190 Handle MD files as Vue elements. ),.+ vueMd(/ * Options */)// u2190 Collect MD documents to Vue components.]// ...To collect a Vue.js codeblock as a Trial Block, include demo alongside the language label:."' vue demo.
Click me."'( end).Multi-file demonstrations.The entry purpose for trial blocks need to be actually a Vue.js element. But you can easily import various other code blocks in any type of language coming from the same Markdown documents.For non-entry data, put a documents name via demonstration=. Then bring in it coming from the Vue.js trial block using the doctor: procedure:.
Click me.
2nd data:.demo= click-handler. js.export const clickHandler = () => sharp(' Clicked on!').Trial + Code blocks out.Since the code blocks are actually delivered inline, they're switched out by the true Vue.js element. To present the code block, you may include a onDemo callback to the plugin choices:.( onDemo( componentTag, code) // Register the wrapper part.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Return a custom-made HTML strand.return '.$ componentTag
$ this.escapeHtml( code)'. ).Options.feature.Kind: ReadonlyArray|string|RegExp.Files to feature coming from being organized as Vue files.exclude.Type: ReadonlyArray|string|RegExp.Files to exclude coming from being assembled as Vue data.markdownItOptions.Kind: markdownIt.Options.MarkdownIt choices. Check out MarkdownIt's paperwork to read more.markdownItSetup.Kind: (md: markdownIt) => void.Callback to incorporate plugins to MarkdownIt.wrapperClass.Style: string.Default: markdown-body.The lesson to add to the cover aspect which contains the Accounting allowance page.onDemo.Kind:.(.tag: string,.code: string,.trials: Chart.) => cord.You can easily intercept each trial block and also come back a customized HTML string. This serves for incorporating customized designing to trial blocks.Additionally, there are utils exposed in the this circumstance:.escapeHtml: Retreat HTML code to stop it from being actually rendered as HTML.registerComponent: Register a part to be utilized in the demo block. This is useful for registering elements that are actually imported coming from various other data.View instance over in the Demonstration Blocks section.markdownCss.Kind: string.File path to a stylesheet to utilize for the Fall page. This will certainly be included utilizing so it is going to only apply to the markdown web page. Helpful for designating only the HTML produced by the MarkdownIt plugin.useVOnce.Kind: boolean.Whether to incorporate v-once to the whole entire Markdown webpage. This will protect against the Markdown web page from being re-rendered when the Vue part is improved.Alert: This will certainly turn off demonstration blocks. Merely utilize this if you possess a huge document and don't require demonstration blocks.Related.unplugin-vue-markdown.An additional Vite plugin for organizing Fall data to Vue elements.This plugin has actually pulled creativity from it however possesses a different component collection. This plugin just supports Vue.js code in code blocks.Github.View Github.