.This Vite plugin includes assistance for importing a Markdown file as a Vue element. Functions along with Vue 2 & 3.Vue.js Trial Blocks.Make your Vue.js code blocks inline through merely including demonstration alongside the language title.For instance, when this Accounting allowance documents is actually rendered through this plugin, you'll find a clickable switch right here:."' vue demonstration.
Click me."'( end).Put in.npm put up -D vite-vue-md.Setup.In your vite.config.js data:.Bring in vite-vue-md and include it to the plugins variety.In your vue() plugin options, incorporate a consist of choice that includes.md files.vite.config.js:.import vue from '@vitejs/ plugin-vue'.+ import vueMd coming from 'vite-vue-md'.export default plugins: [// ...vue( + consist of: [/. vue$/,/ . md$/]// u2190 Deal with MD files as Vue components. ),.+ vueMd(/ * Options */)// u2190 Collect MD reports to Vue elements.]// ...To assemble a Vue.js codeblock as a Trial Block, include demo beside the foreign language name:."' vue demo.
Click me."'( end).Multi-file demonstrations.The access aim for demo blocks should be a Vue.js component. Yet you may import other code blocks in any language from the very same Fall documents.For non-entry reports, set a documents title via demonstration=. At that point bring in it coming from the Vue.js demo block via the doc: protocol:.
Click me.
Second report:.trial= click-handler. js.export const clickHandler = () => alert(' Clicked!').Demonstration + Code blocks out.Due to the fact that the code blocks are provided inline, they're substituted by the true Vue.js component. To reveal the code block, you can incorporate a onDemo callback to the plugin alternatives:.( onDemo( componentTag, code) // Sign up the wrapper element.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Come back a customized HTML cord.gain '.$ componentTag
$ this.escapeHtml( code)'. ).Possibilities.consist of.Type: ReadonlyArray|chain|RegExp.Files to consist of coming from being actually organized as Vue documents.leave out.Type: ReadonlyArray|string|RegExp.Documents to omit from being assembled as Vue reports.markdownItOptions.Kind: markdownIt.Options.MarkdownIt choices. See MarkdownIt's paperwork to read more.markdownItSetup.Type: (md: markdownIt) => space.Callback to include plugins to MarkdownIt.wrapperClass.Kind: string.Default: markdown-body.The training class to include in the wrapper element which contains the Markdown web page.onDemo.Style:.(.tag: strand,.code: string,.demonstrations: Map.) => strand.You can obstruct each demo block as well as return a custom-made HTML cord. This serves for adding custom designing to demo blocks.Furthermore, there are utils left open in the this circumstance:.escapeHtml: Getaway HTML code to stop it coming from being actually rendered as HTML.registerComponent: Sign up a part to become made use of in the demonstration block. This is useful for signing up components that are actually imported from various other reports.View instance over in the Trial Blocks part.markdownCss.Style: chain.Submit course to a stylesheet to use for the Markdown page. This are going to be actually incorporated using so it will merely apply to the fall page. Useful for styling merely the HTML created by the MarkdownIt plugin.useVOnce.Kind: boolean.Whether to include v-once to the entire Markdown page. This will definitely protect against the Accounting allowance webpage coming from being actually re-rendered when the Vue element is upgraded.Alert: This will certainly turn off demo blocks. Only use this if you possess a huge record and do not require trial blocks.Related.unplugin-vue-markdown.One more Vite plugin for organizing Markdown documents to Vue elements.This plugin has drawn inspiration coming from it yet possesses a different component collection. This plugin simply assists Vue.js code in code blocks.Github.View Github.