.This Vite plugin adds assistance for importing a Markdown file as a Vue component. Functions with Vue 2 & 3.Vue.js Demonstration Blocks.Leave your Vue.js code obstructs inline by just including demonstration close to the language name.For instance, when this Markdown documents is actually left using this plugin, you'll find a clickable switch below:."' vue trial.
Click me."'( end).Put up.npm put up -D vite-vue-md.Setup.In your vite.config.js report:.Bring in vite-vue-md as well as include it to the plugins array.In your vue() plugin options, include a feature possibility 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( + feature: [/. vue$/,/ . md$/]// u2190 Treat MD reports as Vue parts. ),.+ vueMd(/ * Options */)// u2190 Assemble MD data to Vue parts.]// ...To put together a Vue.js codeblock as a Trial Block, include trial close to the language name:."' vue demonstration.
Click me."'( end).Multi-file demonstrations.The admittance point for demonstration blocks must be a Vue.js part. Yet you can import other code obstructs in any sort of language coming from the same Fall documents.For non-entry files, set a data name by means of trial=. Then import it coming from the Vue.js demo block via the doctor: process:.
Click me.
Second file:.demonstration= click-handler. js.export const clickHandler = () => alert(' Clicked on!').Demo + Code obstructs.Considering that the code blocks are made inline, they are actually replaced by the actual Vue.js part. To reveal the code block, you can include a onDemo callback to the plugin choices:.( onDemo( componentTag, code) // Sign up the wrapper element.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Profits a custom-made HTML string.profit '.$ componentTag
$ this.escapeHtml( code)'. ).Possibilities.include.Kind: ReadonlyArray|string|RegExp.Documents to include from being compiled as Vue reports.leave out.Style: ReadonlyArray|chain|RegExp.Reports to omit from being collected as Vue reports.markdownItOptions.Kind: markdownIt.Options.MarkdownIt options. Go to MarkdownIt's documentation for more details.markdownItSetup.Kind: (md: markdownIt) => void.Callback to include plugins to MarkdownIt.wrapperClass.Type: cord.Nonpayment: markdown-body.The lesson to contribute to the wrapper component that contains the Accounting allowance web page.onDemo.Type:.(.tag: string,.code: cord,.trials: Map.) => string.You can intercept each demo block as well as come back a custom-made HTML string. This is useful for adding customized designing to demo blocks.On top of that, there are actually utils revealed in the this circumstance:.escapeHtml: Getaway HTML code to prevent it coming from being actually made as HTML.registerComponent: Register a part to become made use of in the demo block. This is useful for signing up parts that are imported coming from various other documents.View instance over in the Trial Blocks area.markdownCss.Kind: string.Submit path to a stylesheet to utilize for the Markdown webpage. This will be incorporated utilizing so it will just put on the accounting allowance page. Beneficial for designating only the HTML produced by the MarkdownIt plugin.useVOnce.Kind: boolean.Whether to add v-once to the entire Accounting allowance page. This will certainly prevent the Fall webpage coming from being re-rendered when the Vue element is actually upgraded.Alert: This will turn off demonstration blocks. Simply use this if you possess a big document and also don't need to have trial blocks.Associated.unplugin-vue-markdown.Another Vite plugin for collecting Accounting allowance data to Vue components.This plugin has actually attracted creativity coming from it but possesses a different attribute collection. This plugin only assists Vue.js code in code blocks.Github.Viewpoint Github.