.This Vite plugin incorporates help for importing a Markdown data as a Vue component. Functions with Vue 2 & 3.Vue.js Demo Blocks.Provide your Vue.js code blocks out inline by just including demo close to the foreign language name.For example, when this Accounting allowance report is provided using this plugin, you'll find a clickable switch listed here:."' vue demonstration.
Click me."'( end).Install.npm set up -D vite-vue-md.Setup.In your vite.config.js report:.Bring in vite-vue-md and include it to the plugins assortment.In your vue() plugin possibilities, add a feature choice that includes.md files.vite.config.js:.bring in vue coming from '@vitejs/ plugin-vue'.+ bring in vueMd coming from 'vite-vue-md'.export default plugins: [// ...vue( + consist of: [/. vue$/,/ . md$/]// u2190 Handle MD reports as Vue parts. ),.+ vueMd(/ * Options */)// u2190 Collect MD files to Vue elements.]// ...To organize a Vue.js codeblock as a Demo Block, include demo next to the foreign language name:."' vue demo.
Click me."'( end).Multi-file demonstrations.The admittance goal for demo blocks need to be a Vue.js part. Yet you can import various other code blocks in any foreign language from the very same Fall documents.For non-entry data, put a report label through demo=. Then bring in it from the Vue.js trial block by means of the doctor: procedure:.
Click me.
2nd file:.demo= click-handler. js.export const clickHandler = () => sharp(' Clicked!').Trial + Code blocks out.Because the code blocks are actually made inline, they're substituted due to the genuine Vue.js component. To present the code block, you can easily add a onDemo callback to the plugin choices:.( onDemo( componentTag, code) // Sign up the wrapper component.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Profits a custom HTML strand.yield '.$ componentTag
$ this.escapeHtml( code)'. ).Possibilities.include.Kind: ReadonlyArray|string|RegExp.Reports to consist of coming from being actually assembled as Vue data.exclude.Kind: ReadonlyArray|string|RegExp.Data to exclude coming from being assembled as Vue data.markdownItOptions.Type: markdownIt.Options.MarkdownIt alternatives. Visit MarkdownIt's documents to find out more.markdownItSetup.Type: (md: markdownIt) => gap.Callback to add plugins to MarkdownIt.wrapperClass.Type: cord.Nonpayment: markdown-body.The class to include in the wrapper factor which contains the Fall webpage.onDemo.Style:.(.tag: cord,.code: cord,.trials: Map.) => string.You may obstruct each demonstration block and come back a personalized HTML cord. This works for including custom designing to trial blocks.In addition, there are utils revealed in the this situation:.escapeHtml: Breaking away HTML code to prevent it from being actually made as HTML.registerComponent: Sign up a part to become used in the demo block. This works for enrolling components that are actually imported from other files.View example above in the Demonstration Blocks section.markdownCss.Type: chain.Submit pathway to a stylesheet to utilize for the Fall page. This will definitely be actually incorporated making use of so it is going to simply put on the markdown page. Helpful for designating simply the HTML generated due to the MarkdownIt plugin.useVOnce.Type: boolean.Whether to add v-once to the whole entire Fall webpage. This will definitely avoid the Fall web page from being re-rendered when the Vue component is upgraded.Warning: This will definitely disable demo blocks. Only use this if you have a large file as well as do not require demonstration blocks.Associated.unplugin-vue-markdown.An additional Vite plugin for organizing Markdown data to Vue parts.This plugin has pulled motivation coming from it but has a various attribute set. This plugin only sustains Vue.js code in code blocks.Github.Perspective Github.