.This Vite plugin adds help for importing a Markdown documents as a Vue part. Functions with Vue 2 & 3.Vue.js Trial Blocks.Provide your Vue.js code obstructs inline through just adding trial beside the language name.As an example, when this Markdown documents is provided using this plugin, you'll observe a clickable button below:."' vue trial.
Click me."'( end).Mount.npm mount -D vite-vue-md.Setup.In your vite.config.js report:.Import vite-vue-md as well as incorporate it to the plugins assortment.In your vue() plugin choices, add a consist of option 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( + include: [/. vue$/,/ . md$/]// u2190 Treat MD files as Vue parts. ),.+ vueMd(/ * Options */)// u2190 Compile MD files to Vue elements.]// ...To put together a Vue.js codeblock as a Demo Block, include demo close to the language title:."' vue demo.
Click me."'( end).Multi-file demonstrations.The access aim for demo blocks must be a Vue.js part. But you may import various other code blocks out in any type of language coming from the very same Markdown file.For non-entry data, put a documents name by means of demonstration=. Then bring in it from the Vue.js trial block using the doc: protocol:.
Click me.
Second documents:.demo= click-handler. js.export const clickHandler = () => sharp(' Clicked on!').Demonstration + Code obstructs.Due to the fact that the code blocks are made inline, they're switched out by the true Vue.js part. To reveal the code block, you may include a onDemo callback to the plugin options:.( onDemo( componentTag, code) // Sign up the cover component.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Come back a custom HTML strand.profit '.$ componentTag
$ this.escapeHtml( code)'. ).Options.feature.Type: ReadonlyArray|chain|RegExp.Documents to include from being compiled as Vue data.leave out.Type: ReadonlyArray|chain|RegExp.Reports to omit coming from being compiled as Vue files.markdownItOptions.Kind: markdownIt.Options.MarkdownIt options. Go to MarkdownIt's documentation for more information.markdownItSetup.Kind: (md: markdownIt) => gap.Callback to add plugins to MarkdownIt.wrapperClass.Kind: cord.Nonpayment: markdown-body.The training class to contribute to the wrapper component which contains the Fall page.onDemo.Type:.(.tag: cord,.code: strand,.trials: Map.) => string.You can intercept each demonstration block and also come back a customized HTML string. This works for adding custom styling to demo blocks.On top of that, there are utils revealed in the this context:.escapeHtml: Getaway HTML code to stop it coming from being actually left as HTML.registerComponent: Register a part to become made use of in the demo block. This serves for signing up elements that are imported from other data.View instance over in the Demonstration Blocks part.markdownCss.Kind: chain.File pathway to a stylesheet to utilize for the Markdown page. This will be actually incorporated using so it is going to only put on the accounting allowance page. Practical for designating only the HTML created due to the MarkdownIt plugin.useVOnce.Type: boolean.Whether to include v-once to the whole Accounting allowance webpage. This will certainly stop the Fall page from being actually re-rendered when the Vue component is actually updated.Precaution: This will certainly turn off demonstration blocks. Just use this if you have a big paper and also don't need to have trial blocks.Related.unplugin-vue-markdown.Another Vite plugin for compiling Fall files to Vue elements.This plugin has actually pulled inspiration from it yet has a different feature set. This plugin only sustains Vue.js code in code blocks.Github.View Github.