.This Vite plugin adds help for importing a Markdown report as a Vue element. Functions with Vue 2 & 3.Vue.js Demo Blocks.Leave your Vue.js code shuts out inline by simply including trial alongside the foreign language name.For example, when this Markdown documents is actually left using this plugin, you'll view a clickable switch listed here:."' vue trial.
Click me."'( end).Mount.npm put up -D vite-vue-md.Create.In your vite.config.js file:.Import vite-vue-md and add it to the plugins collection.In your vue() plugin alternatives, incorporate an include option that includes.md data.vite.config.js:.bring in vue coming from '@vitejs/ plugin-vue'.+ import vueMd from 'vite-vue-md'.export nonpayment plugins: [// ...vue( + consist of: [/. vue$/,/ . md$/]// u2190 Manage MD data as Vue parts. ),.+ vueMd(/ * Options */)// u2190 Collect MD documents to Vue elements.]// ...To compile a Vue.js codeblock as a Demo Block, include trial beside the language title:."' vue demonstration.
Click me."'( end).Multi-file demonstrations.The admittance aim for trial blocks should be actually a Vue.js part. But you can easily import various other code shuts out in any kind of foreign language coming from the same Accounting allowance data.For non-entry reports, set a file title using demo=. Then bring in it from the Vue.js demo block by means of the doc: process:.
Click me.
Second report:.demo= click-handler. js.export const clickHandler = () => alert(' Clicked on!').Trial + Code shuts out.Because the code blocks are actually rendered inline, they're replaced due to the genuine Vue.js element. To reveal the code block, you can incorporate a onDemo callback to the plugin alternatives:.( onDemo( componentTag, code) // Register the wrapper component.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Return a custom-made HTML string.return '.$ componentTag
$ this.escapeHtml( code)'. ).Possibilities.consist of.Type: ReadonlyArray|chain|RegExp.Data to consist of from being put together as Vue files.leave out.Type: ReadonlyArray|chain|RegExp.Reports to leave out coming from being assembled as Vue files.markdownItOptions.Type: markdownIt.Options.MarkdownIt options. Go to MarkdownIt's records for additional information.markdownItSetup.Style: (md: markdownIt) => gap.Callback to include plugins to MarkdownIt.wrapperClass.Style: strand.Default: markdown-body.The training class to include in the wrapper factor that contains the Accounting allowance web page.onDemo.Kind:.(.tag: strand,.code: cord,.demos: Chart.) => string.You may obstruct each demo block and return a personalized HTML string. This is useful for including personalized designing to trial blocks.Furthermore, there are actually utils exposed in the this circumstance:.escapeHtml: Escape HTML code to stop it from being actually left as HTML.registerComponent: Register a part to be made use of in the demonstration block. This serves for enrolling elements that are actually imported from various other files.Observe instance over in the Demonstration Blocks part.markdownCss.Type: chain.File pathway to a stylesheet to use for the Accounting allowance web page. This will definitely be incorporated using so it is going to only relate to the accounting allowance page. Practical for styling simply the HTML produced by the MarkdownIt plugin.useVOnce.Kind: boolean.Whether to include v-once to the whole entire Markdown web page. This will definitely protect against the Fall web page coming from being actually re-rendered when the Vue part is upgraded.Precaution: This are going to turn off trial blocks. Simply utilize this if you possess a huge documentation as well as do not require trial blocks.Associated.unplugin-vue-markdown.An additional Vite plugin for assembling Markdown reports to Vue parts.This plugin has attracted ideas from it however has a different feature collection. This plugin simply supports Vue.js code in code blocks.Github.View Github.