.This Vite plugin includes support for importing a Fall file as a Vue component. Performs with Vue 2 & 3.Vue.js Trial Blocks.Leave your Vue.js code obstructs inline by merely incorporating demo beside the language name.For instance, when this Markdown file is provided with this plugin, you'll observe a clickable button below:."' vue demonstration.
Click me."'( end).Put up.npm put up -D vite-vue-md.Setup.In your vite.config.js file:.Bring in vite-vue-md as well as include it to the plugins assortment.In your vue() plugin choices, incorporate a feature alternative that includes.md files.vite.config.js:.bring in vue from '@vitejs/ plugin-vue'.+ import vueMd from 'vite-vue-md'.export default plugins: [// ...vue( + consist of: [/. vue$/,/ . md$/]// u2190 Deal with MD documents as Vue elements. ),.+ vueMd(/ * Options */)// u2190 Collect MD reports to Vue elements.]// ...To organize a Vue.js codeblock as a Demo Block, add demonstration alongside the foreign language title:."' vue demonstration.
Click me."'( end).Multi-file demos.The entry purpose for demo blocks have to be actually a Vue.js part. Yet you can import various other code blocks in any language coming from the same Accounting allowance file.For non-entry documents, placed a file name by means of demo=. At that point import it from the Vue.js trial block via the doc: process:.
Click me.
Second file:.trial= click-handler. js.export const clickHandler = () => sharp(' Clicked on!').Demo + Code obstructs.Due to the fact that the code blocks are rendered inline, they're replaced by the actual Vue.js component. To reveal the code block, you may add a onDemo callback to the plugin alternatives:.( onDemo( componentTag, code) // Register the wrapper element.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Come back a customized HTML string.gain '.$ componentTag
$ this.escapeHtml( code)'. ).Alternatives.include.Style: ReadonlyArray|string|RegExp.Data to feature from being actually put together as Vue data.omit.Kind: ReadonlyArray|string|RegExp.Files to exclude from being assembled as Vue files.markdownItOptions.Style: markdownIt.Options.MarkdownIt choices. Check out MarkdownIt's paperwork to find out more.markdownItSetup.Type: (md: markdownIt) => gap.Callback to include plugins to MarkdownIt.wrapperClass.Kind: string.Default: markdown-body.The course to add to the wrapper component which contains the Accounting allowance page.onDemo.Style:.(.tag: strand,.code: string,.trials: Map.) => cord.You can intercept each trial block and also come back a customized HTML cord. This serves for including personalized designing to trial blocks.Moreover, there are actually utils exposed in the this context:.escapeHtml: Escape HTML code to prevent it from being left as HTML.registerComponent: Sign up a component to be used in the trial block. This serves for registering elements that are actually imported coming from various other files.View instance above in the Demo Blocks segment.markdownCss.Type: chain.File path to a stylesheet to make use of for the Accounting allowance web page. This will definitely be actually incorporated utilizing so it will only put on the markdown web page. Valuable for styling simply the HTML produced by the MarkdownIt plugin.useVOnce.Style: boolean.Whether to add v-once to the whole Markdown web page. This will avoid the Fall page from being actually re-rendered when the Vue part is improved.Warning: This will definitely turn off demonstration blocks. Merely use this if you have a sizable record and do not require trial blocks.Associated.unplugin-vue-markdown.One more Vite plugin for assembling Markdown files to Vue components.This plugin has drawn ideas coming from it yet has a various attribute collection. This plugin only supports Vue.js code in code blocks.Github.Perspective Github.