.This Vite plugin incorporates assistance for importing a Fall data as a Vue component. Works with Vue 2 & 3.Vue.js Demo Blocks.Make your Vue.js code blocks inline by just including demonstration next to the language name.For instance, when this Fall file is actually made using this plugin, you'll observe a clickable switch right here:."' vue demo.
Click me."'( end).Mount.npm put up -D vite-vue-md.Setup.In your vite.config.js file:.Bring in vite-vue-md and incorporate it to the plugins selection.In your vue() plugin alternatives, incorporate an include choice that includes.md files.vite.config.js:.bring in vue coming from '@vitejs/ plugin-vue'.+ bring in vueMd from 'vite-vue-md'.export default plugins: [// ...vue( + feature: [/. vue$/,/ . md$/]// u2190 Manage MD documents as Vue components. ),.+ vueMd(/ * Options */)// u2190 Compile MD files to Vue components.]// ...To put together a Vue.js codeblock as a Demonstration Block, add demo alongside the foreign language label:."' vue demonstration.
Click me."'( end).Multi-file demonstrations.The access point for demo blocks need to be actually a Vue.js part. However you can easily import other code obstructs in any kind of foreign language from the same Markdown documents.For non-entry files, placed a data label through demo=. After that bring in it coming from the Vue.js demo block through the doc: protocol:.
Click me.
2nd report:.demo= click-handler. js.export const clickHandler = () => alert(' Clicked!').Trial + Code blocks.Since the code blocks are rendered inline, they are actually switched out due to the true Vue.js component. To show the code block, you can incorporate a onDemo callback to the plugin options:.( onDemo( componentTag, code) // Sign up the wrapper element.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Come back a personalized HTML cord.yield '.$ componentTag
$ this.escapeHtml( code)'. ).Choices.feature.Kind: ReadonlyArray|string|RegExp.Reports to include from being compiled as Vue data.leave out.Type: ReadonlyArray|chain|RegExp.Data to omit from being collected as Vue documents.markdownItOptions.Type: markdownIt.Options.MarkdownIt possibilities. See MarkdownIt's documentation to read more.markdownItSetup.Type: (md: markdownIt) => space.Callback to include plugins to MarkdownIt.wrapperClass.Type: string.Default: markdown-body.The course to include in the cover aspect which contains the Markdown page.onDemo.Type:.(.tag: strand,.code: string,.demos: Chart.) => cord.You can easily obstruct each trial block as well as come back a custom-made HTML strand. This is useful for incorporating custom designing to demo blocks.On top of that, there are utils subjected in the this situation:.escapeHtml: Getaway HTML code to avoid it coming from being actually provided as HTML.registerComponent: Sign up an element to be used in the demonstration block. This is useful for enrolling components that are actually imported from various other reports.See example over in the Demo Blocks area.markdownCss.Kind: string.File pathway to a stylesheet to utilize for the Fall webpage. This are going to be included utilizing so it will merely apply to the markdown webpage. Practical for designating merely the HTML generated by the MarkdownIt plugin.useVOnce.Type: boolean.Whether to include v-once to the whole Accounting allowance web page. This will certainly avoid the Markdown web page coming from being re-rendered when the Vue element is actually improved.Caution: This will disable trial blocks. Merely use this if you possess a huge file and do not need to have trial blocks.Associated.unplugin-vue-markdown.An additional Vite plugin for organizing Fall reports to Vue elements.This plugin has actually drawn motivation coming from it yet has a various feature collection. This plugin merely sustains Vue.js code in code blocks.Github.Sight Github.