.This Vite plugin incorporates assistance for importing a Markdown report as a Vue part. Performs along with Vue 2 & 3.Vue.js Trial Blocks.Render your Vue.js code blocks inline by simply including demo next to the language title.For instance, when this Fall data is left with this plugin, you'll find a clickable switch right here:."' vue demo.
Click me."'( end).Put up.npm mount -D vite-vue-md.Setup.In your vite.config.js data:.Import vite-vue-md and also incorporate it to the plugins selection.In your vue() plugin options, add a consist of possibility that includes.md data.vite.config.js:.import vue coming from '@vitejs/ plugin-vue'.+ bring in vueMd coming from 'vite-vue-md'.export nonpayment plugins: [// ...vue( + consist of: [/. vue$/,/ . md$/]// u2190 Manage MD documents as Vue parts. ),.+ vueMd(/ * Options */)// u2190 Assemble MD reports to Vue parts.]// ...To put together a Vue.js codeblock as a Trial Block, incorporate demonstration next to the language title:."' vue demo.
Click me."'( end).Multi-file demonstrations.The admittance point for demonstration blocks need to be a Vue.js component. But you can easily import various other code shuts out in any language coming from the very same Markdown documents.For non-entry reports, placed a report label via trial=. At that point import it from the Vue.js trial block by means of the doc: method:.
Click me.
2nd documents:.demo= click-handler. js.export const clickHandler = () => alert(' Clicked on!').Demo + Code obstructs.Since the code blocks are rendered inline, they're substituted due to the genuine Vue.js element. To reveal the code block, you can add a onDemo callback to the plugin alternatives:.( onDemo( componentTag, code) // Register the cover part.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Profits a personalized HTML string.yield '.$ componentTag
$ this.escapeHtml( code)'. ).Options.feature.Type: ReadonlyArray|string|RegExp.Reports to consist of coming from being actually collected as Vue documents.leave out.Type: ReadonlyArray|chain|RegExp.Files to omit coming from being assembled as Vue files.markdownItOptions.Kind: markdownIt.Options.MarkdownIt options. Check out MarkdownIt's information to find out more.markdownItSetup.Style: (md: markdownIt) => space.Callback to include plugins to MarkdownIt.wrapperClass.Kind: strand.Nonpayment: markdown-body.The class to include in the wrapper element which contains the Accounting allowance web page.onDemo.Style:.(.tag: strand,.code: string,.demos: Map.) => strand.You can easily intercept each demo block and return a customized HTML string. This works for including customized designing to trial blocks.Furthermore, there are actually utils revealed in the this situation:.escapeHtml: Escape HTML code to stop it coming from being made as HTML.registerComponent: Register a part to become used in the demo block. This is useful for enrolling components that are actually imported coming from other data.Observe example above in the Demonstration Blocks section.markdownCss.Style: chain.File course to a stylesheet to utilize for the Accounting allowance web page. This will be actually included utilizing so it is going to just relate to the accounting allowance page. Valuable for designating merely the HTML generated due to the MarkdownIt plugin.useVOnce.Style: boolean.Whether to incorporate v-once to the whole entire Accounting allowance web page. This will certainly prevent the Markdown web page coming from being re-rendered when the Vue component is actually upgraded.Precaution: This will definitely turn off demonstration blocks. Simply utilize this if you possess a large file and also don't need demonstration blocks.Related.unplugin-vue-markdown.Yet another Vite plugin for assembling Markdown reports to Vue components.This plugin has pulled creativity coming from it but possesses a different feature collection. This plugin only assists Vue.js code in code blocks.Github.View Github.