.This Vite plugin adds assistance for importing a Markdown data as a Vue component. Works along with Vue 2 & 3.Vue.js Trial Blocks.Leave your Vue.js code obstructs inline by just adding demonstration next to the language title.For example, when this Accounting allowance documents is actually left through this plugin, you'll view a clickable switch listed here:."' vue demonstration.
Click me."'( end).Put in.npm install -D vite-vue-md.Create.In your vite.config.js report:.Import vite-vue-md as well as add it to the plugins array.In your vue() plugin options, include an include alternative that includes.md data.vite.config.js:.bring in vue coming from '@vitejs/ plugin-vue'.+ import vueMd coming from 'vite-vue-md'.export nonpayment plugins: [// ...vue( + feature: [/. vue$/,/ . md$/]// u2190 Alleviate MD reports as Vue components. ),.+ vueMd(/ * Options */)// u2190 Put together MD data to Vue elements.]// ...To compile a Vue.js codeblock as a Trial Block, incorporate trial beside the foreign language label:."' vue trial.
Click me."'( end).Multi-file demonstrations.The access goal for demonstration blocks must be actually a Vue.js element. However you can import various other code shuts out in any kind of language from the exact same Markdown data.For non-entry reports, established a documents title through demo=. After that import it coming from the Vue.js trial block by means of the doctor: process:.
Click me.
2nd documents:.demo= click-handler. js.export const clickHandler = () => alert(' Clicked on!').Trial + Code blocks out.Because the code blocks are delivered inline, they're switched out by the actual Vue.js element. To reveal the code block, you can include a onDemo callback to the plugin possibilities:.( onDemo( componentTag, code) // Sign up the wrapper component.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Profits a custom-made HTML cord.profit '.$ componentTag
$ this.escapeHtml( code)'. ).Options.include.Style: ReadonlyArray|chain|RegExp.Data to feature from being actually compiled as Vue documents.omit.Type: ReadonlyArray|chain|RegExp.Reports to exclude from being organized as Vue reports.markdownItOptions.Style: markdownIt.Options.MarkdownIt alternatives. Check out MarkdownIt's information to read more.markdownItSetup.Kind: (md: markdownIt) => void.Callback to include plugins to MarkdownIt.wrapperClass.Style: strand.Default: markdown-body.The course to include in the cover factor that contains the Markdown webpage.onDemo.Type:.(.tag: string,.code: string,.trials: Chart.) => string.You can obstruct each demo block and return a personalized HTML strand. This is useful for incorporating custom-made styling to trial blocks.Additionally, there are utils subjected in the this situation:.escapeHtml: Breaking away HTML code to prevent it coming from being actually provided as HTML.registerComponent: Register an element to be made use of in the demonstration block. This serves for enrolling parts that are imported from various other reports.Find example over in the Demo Blocks part.markdownCss.Type: chain.Submit road to a stylesheet to use for the Accounting allowance web page. This are going to be included using so it is going to merely relate to the accounting allowance web page. Beneficial for designating merely the HTML produced by the MarkdownIt plugin.useVOnce.Kind: boolean.Whether to include v-once to the entire Markdown webpage. This will prevent the Fall page coming from being re-rendered when the Vue element is improved.Precaution: This are going to turn off demonstration blocks. Just utilize this if you possess a sizable document as well as do not require trial blocks.Associated.unplugin-vue-markdown.Another Vite plugin for compiling Accounting allowance documents to Vue components.This plugin has attracted creativity from it but has a different component set. This plugin merely sustains Vue.js code in code blocks.Github.Scenery Github.