.This Vite plugin includes support for importing a Markdown report as a Vue component. Performs with Vue 2 & 3.Vue.js Demonstration Blocks.Leave your Vue.js code obstructs inline through merely adding trial beside the foreign language name.For instance, when this Accounting allowance data is rendered with this plugin, you'll observe a clickable switch listed here:."' vue demo.
Click me."'( end).Put up.npm put in -D vite-vue-md.Create.In your vite.config.js data:.Bring in vite-vue-md and add it to the plugins variety.In your vue() plugin choices, incorporate a consist of alternative that includes.md documents.vite.config.js:.import vue coming from '@vitejs/ plugin-vue'.+ bring in vueMd coming from 'vite-vue-md'.export nonpayment plugins: [// ...vue( + consist of: [/. vue$/,/ . md$/]// u2190 Deal with MD data as Vue components. ),.+ vueMd(/ * Options */)// u2190 Collect MD data to Vue parts.]// ...To assemble a Vue.js codeblock as a Demo Block, incorporate demo close to the language title:."' vue demo.
Click me."'( end).Multi-file demonstrations.The entry purpose for trial blocks have to be actually a Vue.js element. However you may import various other code blocks out in any kind of language from the very same Markdown file.For non-entry files, established a report name through demonstration=. At that point import it from the Vue.js demo block using the doc: protocol:.
Click me.
Second file:.demo= click-handler. js.export const clickHandler = () => alert(' Clicked on!').Demonstration + Code blocks.Given that the code blocks are actually delivered inline, they are actually changed by the actual Vue.js element. To reveal the code block, you can add a onDemo callback to the plugin possibilities:.( onDemo( componentTag, code) // Register the cover element.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Profits a personalized HTML cord.yield '.$ componentTag
$ this.escapeHtml( code)'. ).Choices.consist of.Kind: ReadonlyArray|string|RegExp.Files to consist of from being compiled as Vue reports.leave out.Style: ReadonlyArray|chain|RegExp.Files to exclude from being actually assembled as Vue reports.markdownItOptions.Type: markdownIt.Options.MarkdownIt possibilities. Check out MarkdownIt's records for additional information.markdownItSetup.Kind: (md: markdownIt) => space.Callback to add plugins to MarkdownIt.wrapperClass.Kind: string.Default: markdown-body.The class to contribute to the cover element which contains the Accounting allowance page.onDemo.Kind:.(.tag: cord,.code: strand,.demonstrations: Chart.) => string.You may obstruct each trial block and return a personalized HTML string. This is useful for adding personalized styling to demonstration blocks.Moreover, there are utils revealed in the this circumstance:.escapeHtml: Escape HTML code to prevent it coming from being left as HTML.registerComponent: Sign up a component to become utilized in the trial block. This serves for enrolling components that are imported from other reports.Find instance above in the Trial Blocks section.markdownCss.Type: string.Submit road to a stylesheet to make use of for the Fall web page. This will certainly be actually included using so it is going to just relate to the fall web page. Useful for designating simply the HTML produced by the MarkdownIt plugin.useVOnce.Type: boolean.Whether to incorporate v-once to the entire Accounting allowance web page. This will certainly stop the Markdown webpage from being actually re-rendered when the Vue element is actually upgraded.Warning: This will turn off trial blocks. Only use this if you possess a large file as well as don't need to have demo blocks.Associated.unplugin-vue-markdown.Yet another Vite plugin for assembling Accounting allowance documents to Vue parts.This plugin has pulled inspiration from it yet has a various attribute collection. This plugin simply supports Vue.js code in code blocks.Github.View Github.