.This Vite plugin includes support for importing a Fall report as a Vue component. Functions with Vue 2 & 3.Vue.js Demo Blocks.Provide your Vue.js code blocks out inline by merely incorporating demo close to the language title.For example, when this Fall documents is actually made using this plugin, you'll see a clickable button right here:."' vue demonstration.
Click me."'( end).Put in.npm set up -D vite-vue-md.Setup.In your vite.config.js file:.Import vite-vue-md as well as add it to the plugins array.In your vue() plugin alternatives, add a feature 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 reports as Vue elements. ),.+ vueMd(/ * Options */)// u2190 Collect MD files to Vue components.]// ...To organize a Vue.js codeblock as a Trial Block, incorporate trial beside the foreign language name:."' vue demonstration.
Click me."'( end).Multi-file demonstrations.The entry goal for demo blocks should be actually a Vue.js element. But you may import other code blocks in any sort of language from the same Markdown report.For non-entry documents, placed a data title through demo=. Then bring in it coming from the Vue.js trial block via the doc: protocol:.
Click me.
2nd report:.demo= click-handler. js.export const clickHandler = () => sharp(' Clicked!').Demonstration + Code shuts out.Due to the fact that the code blocks are rendered inline, they are actually substituted due to the genuine Vue.js element. To show the code block, you can easily include a onDemo callback to the plugin choices:.( onDemo( componentTag, code) // Register the cover element.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Profits a custom-made HTML strand.yield '.$ componentTag
$ this.escapeHtml( code)'. ).Choices.include.Kind: ReadonlyArray|chain|RegExp.Documents to consist of coming from being actually put together as Vue documents.omit.Kind: ReadonlyArray|string|RegExp.Documents to omit from being collected as Vue data.markdownItOptions.Style: markdownIt.Options.MarkdownIt alternatives. Check out MarkdownIt's documentation for more information.markdownItSetup.Kind: (md: markdownIt) => space.Callback to add plugins to MarkdownIt.wrapperClass.Type: cord.Default: markdown-body.The lesson to add to the wrapper element that contains the Fall web page.onDemo.Style:.(.tag: cord,.code: string,.trials: Map.) => strand.You can easily obstruct each trial block and also come back a custom-made HTML string. This is useful for including customized designing to demonstration blocks.Furthermore, there are actually utils exposed in the this context:.escapeHtml: Breaking away HTML code to stop it coming from being actually provided as HTML.registerComponent: Sign up an element to become made use of in the demo block. This works for signing up components that are actually imported coming from various other files.Observe example above in the Demonstration Blocks area.markdownCss.Type: string.Submit pathway to a stylesheet to make use of for the Fall page. This will definitely be incorporated using so it will simply relate to the accounting allowance page. Beneficial for designating only the HTML created due to the MarkdownIt plugin.useVOnce.Type: boolean.Whether to incorporate v-once to the entire Accounting allowance webpage. This will stop the Accounting allowance web page from being actually re-rendered when the Vue element is upgraded.Warning: This are going to turn off demonstration blocks. Simply use this if you possess a big paper and do not need to have demonstration blocks.Associated.unplugin-vue-markdown.Yet another Vite plugin for organizing Markdown reports to Vue elements.This plugin has attracted creativity from it yet possesses a different function set. This plugin simply sustains Vue.js code in code blocks.Github.Sight Github.