.This Vite plugin incorporates help for importing a Markdown report as a Vue part. Works with Vue 2 & 3.Vue.js Demo Blocks.Make your Vue.js code blocks out inline by simply incorporating trial alongside the language label.As an example, when this Markdown report is actually provided with this plugin, you'll find a clickable button below:."' vue trial.
Click me."'( end).Put up.npm mount -D vite-vue-md.Setup.In your vite.config.js report:.Import vite-vue-md and also include it to the plugins variety.In your vue() plugin alternatives, incorporate an include choice that includes.md files.vite.config.js:.bring in vue from '@vitejs/ plugin-vue'.+ import vueMd from 'vite-vue-md'.export default plugins: [// ...vue( + consist of: [/. vue$/,/ . md$/]// u2190 Handle MD files as Vue components. ),.+ vueMd(/ * Options */)// u2190 Collect MD documents to Vue components.]// ...To compile a Vue.js codeblock as a Demonstration Block, incorporate trial beside the foreign language name:."' vue trial.
Click me."'( end).Multi-file demos.The entry goal for trial blocks need to be actually a Vue.js part. Yet you can import various other code blocks in any language coming from the exact same Fall report.For non-entry data, established a documents name by means of demonstration=. After that bring in it from the Vue.js trial block via the doc: procedure:.
Click me.
Second report:.demonstration= click-handler. js.export const clickHandler = () => alert(' Clicked on!').Demonstration + Code obstructs.Considering that the code blocks are made inline, they're substituted due to the actual Vue.js component. To show the code block, you may add a onDemo callback to the plugin alternatives:.( onDemo( componentTag, code) // Register the cover element.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Return a customized HTML strand.gain '.$ componentTag
$ this.escapeHtml( code)'. ).Options.include.Kind: ReadonlyArray|chain|RegExp.Files to consist of coming from being actually put together as Vue reports.leave out.Style: ReadonlyArray|chain|RegExp.Files to leave out coming from being compiled as Vue documents.markdownItOptions.Style: markdownIt.Options.MarkdownIt possibilities. See MarkdownIt's paperwork for more details.markdownItSetup.Type: (md: markdownIt) => gap.Callback to include plugins to MarkdownIt.wrapperClass.Type: string.Nonpayment: markdown-body.The course to include in the cover aspect that contains the Accounting allowance web page.onDemo.Type:.(.tag: string,.code: cord,.demonstrations: Map.) => strand.You can easily obstruct each demonstration block and return a customized HTML string. This is useful for adding custom-made styling to demonstration blocks.On top of that, there are actually utils revealed in the this context:.escapeHtml: Escape HTML code to stop it from being made as HTML.registerComponent: Register a part to be used in the trial block. This works for enrolling elements that are actually imported from other documents.See instance over in the Demonstration Blocks part.markdownCss.Type: string.Submit road to a stylesheet to make use of for the Accounting allowance webpage. This will definitely be added making use of so it is going to merely relate to the markdown page. Useful for styling simply the HTML generated by the MarkdownIt plugin.useVOnce.Type: boolean.Whether to include v-once to the entire Markdown web page. This will protect against the Fall page coming from being actually re-rendered when the Vue element is upgraded.Caution: This will certainly disable demo blocks. Merely utilize this if you have a big document and also do not need demo blocks.Connected.unplugin-vue-markdown.Another Vite plugin for organizing Markdown reports to Vue parts.This plugin has actually pulled ideas coming from it but has a various component collection. This plugin merely supports Vue.js code in code blocks.Github.Scenery Github.