.This Vite plugin incorporates support for importing a Fall report as a Vue part. Works with Vue 2 & 3.Vue.js Demonstration Blocks.Provide your Vue.js code obstructs inline by simply adding demo alongside the foreign language label.For instance, when this Accounting allowance documents is provided with this plugin, you'll observe a clickable button listed below:."' vue demo.
Click me."'( end).Set up.npm put in -D vite-vue-md.Create.In your vite.config.js data:.Import vite-vue-md and include it to the plugins array.In your vue() plugin choices, include a feature alternative that includes.md documents.vite.config.js:.import vue coming from '@vitejs/ plugin-vue'.+ bring in vueMd from 'vite-vue-md'.export nonpayment plugins: [// ...vue( + include: [/. vue$/,/ . md$/]// u2190 Manage MD documents as Vue parts. ),.+ vueMd(/ * Options */)// u2190 Compile MD files to Vue components.]// ...To organize a Vue.js codeblock as a Demonstration Block, include trial close to the foreign language label:."' vue demonstration.
Click me."'( end).Multi-file demonstrations.The admittance purpose for trial blocks have to be actually a Vue.js element. But you may import various other code obstructs in any type of foreign language from the very same Markdown report.For non-entry reports, put a documents name through demo=. After that import it coming from the Vue.js trial block by means of the doctor: protocol:.
Click me.
Second documents:.demo= click-handler. js.export const clickHandler = () => sharp(' Clicked on!').Demonstration + Code blocks out.Given that the code blocks are actually provided inline, they're substituted due to the true Vue.js element. To reveal the code block, you can include a onDemo callback to the plugin options:.( onDemo( componentTag, code) // Register the cover part.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Profits a custom-made HTML cord.return '.$ componentTag
$ this.escapeHtml( code)'. ).Options.consist of.Kind: ReadonlyArray|chain|RegExp.Data to include from being compiled as Vue data.exclude.Type: ReadonlyArray|string|RegExp.Files to omit coming from being organized as Vue data.markdownItOptions.Type: markdownIt.Options.MarkdownIt alternatives. Visit MarkdownIt's documents to learn more.markdownItSetup.Type: (md: markdownIt) => space.Callback to include plugins to MarkdownIt.wrapperClass.Type: cord.Default: markdown-body.The lesson to contribute to the cover component that contains the Markdown webpage.onDemo.Kind:.(.tag: strand,.code: string,.demos: Chart.) => string.You can easily intercept each demonstration block and also return a personalized HTML cord. This is useful for incorporating customized designing to demo blocks.Additionally, there are actually utils exposed in the this context:.escapeHtml: Retreat HTML code to avoid it coming from being provided as HTML.registerComponent: Register an element to be used in the demonstration block. This is useful for signing up components that are imported coming from various other data.View instance over in the Demo Blocks area.markdownCss.Style: string.Submit road to a stylesheet to make use of for the Accounting allowance web page. This will be actually incorporated utilizing so it will simply apply to the markdown page. Useful for styling simply the HTML generated by the MarkdownIt plugin.useVOnce.Kind: boolean.Whether to add v-once to the entire Accounting allowance page. This will stop the Fall web page from being re-rendered when the Vue element is upgraded.Caution: This will definitely turn off demonstration blocks. Just use this if you possess a big document and also do not require demonstration blocks.Associated.unplugin-vue-markdown.Another Vite plugin for organizing Markdown reports to Vue parts.This plugin has actually drawn ideas from it yet has a different attribute collection. This plugin merely sustains Vue.js code in code blocks.Github.View Github.