.This Vite plugin incorporates help for importing a Markdown data as a Vue element. Performs along with Vue 2 & 3.Vue.js Demonstration Blocks.Provide your Vue.js code shuts out inline by just including demonstration next to the language name.For example, when this Markdown file is actually rendered through this plugin, you'll find a clickable switch right here:."' vue demo.
Click me."'( end).Install.npm put up -D vite-vue-md.Create.In your vite.config.js report:.Import vite-vue-md and also incorporate it to the plugins collection.In your vue() plugin possibilities, include a feature option that includes.md documents.vite.config.js:.bring in vue from '@vitejs/ plugin-vue'.+ import vueMd coming from 'vite-vue-md'.export nonpayment plugins: [// ...vue( + consist of: [/. vue$/,/ . md$/]// u2190 Handle MD data as Vue elements. ),.+ vueMd(/ * Options */)// u2190 Compile MD documents to Vue parts.]// ...To organize a Vue.js codeblock as a Demo Block, include demo alongside the language name:."' vue demo.
Click me."'( end).Multi-file demonstrations.The access goal for trial blocks need to be actually a Vue.js element. However you can easily import various other code obstructs in any foreign language from the same Markdown report.For non-entry reports, put a file name through demonstration=. After that bring in it coming from the Vue.js demo block through the doctor: procedure:.
Click me.
2nd file:.demo= click-handler. js.export const clickHandler = () => sharp(' Clicked on!').Trial + Code obstructs.Since the code blocks are actually rendered inline, they are actually substituted due to the actual Vue.js element. To show the code block, you can easily include a onDemo callback to the plugin possibilities:.( onDemo( componentTag, code) // Sign up the wrapper element.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Return a personalized HTML cord.yield '.$ componentTag
$ this.escapeHtml( code)'. ).Alternatives.consist of.Type: ReadonlyArray|chain|RegExp.Data to feature coming from being assembled as Vue documents.leave out.Style: ReadonlyArray|chain|RegExp.Documents to leave out from being organized as Vue files.markdownItOptions.Style: markdownIt.Options.MarkdownIt possibilities. Check out MarkdownIt's documentation for additional information.markdownItSetup.Type: (md: markdownIt) => gap.Callback to add plugins to MarkdownIt.wrapperClass.Type: strand.Default: markdown-body.The training class to include in the cover aspect that contains the Markdown webpage.onDemo.Style:.(.tag: string,.code: cord,.demos: Map.) => strand.You may intercept each trial block and also return a customized HTML cord. This is useful for including customized designing to demonstration blocks.Moreover, there are utils exposed in the this context:.escapeHtml: Getaway HTML code to prevent it from being rendered as HTML.registerComponent: Register a part to become used in the demo block. This is useful for registering components that are imported coming from other data.Find example above in the Demo Blocks area.markdownCss.Kind: chain.File road to a stylesheet to use for the Markdown webpage. This will certainly be incorporated using so it will simply apply to the accounting allowance webpage. Practical for designating only the HTML created due to the MarkdownIt plugin.useVOnce.Style: boolean.Whether to incorporate v-once to the entire Accounting allowance page. This will prevent the Markdown webpage coming from being actually re-rendered when the Vue part is actually upgraded.Caution: This will certainly disable demo blocks. Just utilize this if you have a huge document as well as do not require demonstration blocks.Related.unplugin-vue-markdown.One more Vite plugin for assembling Accounting allowance reports to Vue components.This plugin has attracted motivation coming from it yet possesses a various function set. This plugin only assists Vue.js code in code blocks.Github.Perspective Github.