.This Vite plugin includes support for importing a Markdown documents as a Vue part. Works with Vue 2 & 3.Vue.js Demonstration Blocks.Provide your Vue.js code blocks inline by simply incorporating demo beside the language name.For instance, when this Accounting allowance data is actually rendered through this plugin, you'll see a clickable button listed below:."' vue demo.
Click me."'( end).Put in.npm put in -D vite-vue-md.Create.In your vite.config.js data:.Import vite-vue-md and add it to the plugins range.In your vue() plugin alternatives, add an include alternative that includes.md files.vite.config.js:.bring in vue coming from '@vitejs/ plugin-vue'.+ import vueMd from 'vite-vue-md'.export nonpayment plugins: [// ...vue( + include: [/. vue$/,/ . md$/]// u2190 Alleviate MD data as Vue parts. ),.+ vueMd(/ * Options */)// u2190 Assemble MD files to Vue parts.]// ...To put together a Vue.js codeblock as a Demo Block, add demo next to the foreign language title:."' vue trial.
Click me."'( end).Multi-file demonstrations.The access goal for trial blocks should be a Vue.js part. But you may import various other code blocks out in any sort of language coming from the exact same Fall data.For non-entry documents, established a report title using trial=. At that point import it from the Vue.js demonstration block by means of the doctor: process:.
Click me.
Second file:.trial= click-handler. js.export const clickHandler = () => sharp(' Clicked!').Trial + Code blocks out.Because the code blocks are made inline, they're replaced by the genuine Vue.js component. To present the code block, you can include a onDemo callback to the plugin alternatives:.( onDemo( componentTag, code) // Register the wrapper component.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Return a personalized HTML strand.gain '.$ componentTag
$ this.escapeHtml( code)'. ).Options.feature.Kind: ReadonlyArray|chain|RegExp.Files to feature coming from being actually collected as Vue data.exclude.Type: ReadonlyArray|string|RegExp.Reports to exclude coming from being actually put together as Vue data.markdownItOptions.Kind: markdownIt.Options.MarkdownIt choices. Check out MarkdownIt's records for additional information.markdownItSetup.Kind: (md: markdownIt) => space.Callback to add plugins to MarkdownIt.wrapperClass.Type: strand.Nonpayment: markdown-body.The training class to contribute to the wrapper aspect that contains the Markdown web page.onDemo.Style:.(.tag: cord,.code: string,.trials: Map.) => cord.You can easily intercept each demo block as well as return a custom-made HTML string. This is useful for adding personalized styling to demonstration blocks.Furthermore, there are actually utils subjected in the this context:.escapeHtml: Getaway HTML code to avoid it coming from being actually provided as HTML.registerComponent: Register a component to become made use of in the demonstration block. This serves for enrolling elements that are imported coming from various other documents.See example above in the Demo Blocks part.markdownCss.Kind: string.Submit road to a stylesheet to utilize for the Fall web page. This will certainly be included using so it is going to only put on the accounting allowance page. Practical for styling simply the HTML generated by the MarkdownIt plugin.useVOnce.Kind: boolean.Whether to include v-once to the entire Markdown web page. This will definitely stop the Fall page from being actually re-rendered when the Vue element is improved.Warning: This are going to turn off demonstration blocks. Only use this if you have a sizable document as well as do not need to have demo blocks.Associated.unplugin-vue-markdown.Another Vite plugin for compiling Fall data to Vue parts.This plugin has actually attracted inspiration from it yet possesses a various attribute collection. This plugin merely assists Vue.js code in code blocks.Github.View Github.