.This Vite plugin adds help for importing a Markdown documents as a Vue element. Works along with Vue 2 & 3.Vue.js Demo Blocks.Make your Vue.js code shuts out inline through simply including trial close to the foreign language label.As an example, when this Accounting allowance report is actually provided through this plugin, you'll see a clickable button right here:."' vue demonstration.
Click me."'( end).Install.npm install -D vite-vue-md.Create.In your vite.config.js report:.Import vite-vue-md as well as include it to the plugins array.In your vue() plugin alternatives, add a feature alternative that includes.md data.vite.config.js:.import vue coming from '@vitejs/ plugin-vue'.+ import vueMd coming from 'vite-vue-md'.export nonpayment plugins: [// ...vue( + include: [/. vue$/,/ . md$/]// u2190 Address MD files as Vue elements. ),.+ vueMd(/ * Options */)// u2190 Collect MD reports to Vue parts.]// ...To collect a Vue.js codeblock as a Demonstration Block, add demo alongside the foreign language name:."' vue demo.
Click me."'( end).Multi-file demonstrations.The access goal for demo blocks should be actually a Vue.js element. Yet you can easily import various other code obstructs in any type of foreign language from the very same Fall report.For non-entry files, set a report label via demo=. Then import it from the Vue.js demonstration block using the doc: procedure:.
Click me.
2nd data:.demonstration= click-handler. js.export const clickHandler = () => alert(' Clicked on!').Demonstration + Code blocks.Due to the fact that the code blocks are actually made inline, they're switched out by the real Vue.js component. To show the code block, you can easily add a onDemo callback to the plugin choices:.( onDemo( componentTag, code) // Register the wrapper element.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Return a personalized HTML string.return '.$ componentTag
$ this.escapeHtml( code)'. ).Alternatives.include.Type: ReadonlyArray|string|RegExp.Files to feature coming from being actually collected as Vue data.omit.Type: ReadonlyArray|string|RegExp.Reports to leave out from being assembled as Vue data.markdownItOptions.Kind: markdownIt.Options.MarkdownIt options. Go to MarkdownIt's paperwork to read more.markdownItSetup.Type: (md: markdownIt) => gap.Callback to add plugins to MarkdownIt.wrapperClass.Type: cord.Default: markdown-body.The training class to contribute to the wrapper factor that contains the Fall webpage.onDemo.Style:.(.tag: string,.code: strand,.demonstrations: Map.) => string.You may obstruct each demo block and also return a custom HTML strand. This works for including customized designing to demonstration blocks.Furthermore, there are actually utils exposed in the this situation:.escapeHtml: Escape HTML code to avoid it from being actually rendered as HTML.registerComponent: Register a part to be made use of in the demonstration block. This works for registering components that are imported coming from various other reports.View example above in the Trial Blocks segment.markdownCss.Style: chain.File road to a stylesheet to use for the Accounting allowance page. This will be included utilizing so it is going to merely relate to the accounting allowance page. Valuable for styling simply the HTML produced by the MarkdownIt plugin.useVOnce.Type: boolean.Whether to include v-once to the whole entire Accounting allowance page. This will certainly protect against the Fall webpage from being actually re-rendered when the Vue part is actually upgraded.Caution: This will certainly disable trial blocks. Simply use this if you possess a sizable record as well as don't need to have demonstration blocks.Connected.unplugin-vue-markdown.One more Vite plugin for assembling Fall files to Vue components.This plugin has drawn creativity coming from it however possesses a different feature set. This plugin just assists Vue.js code in code blocks.Github.Perspective Github.