.This Vite plugin includes assistance for importing a Markdown documents as a Vue element. Works along with Vue 2 & 3.Vue.js Trial Blocks.Make your Vue.js code shuts out inline through just including trial next to the foreign language title.As an example, when this Fall data is left using this plugin, you'll find a clickable button here:."' vue demo.
Click me."'( end).Set up.npm put up -D vite-vue-md.Setup.In your vite.config.js file:.Bring in vite-vue-md and include it to the plugins array.In your vue() plugin choices, incorporate a consist of option that includes.md reports.vite.config.js:.bring in vue coming from '@vitejs/ plugin-vue'.+ import vueMd coming from 'vite-vue-md'.export nonpayment plugins: [// ...vue( + include: [/. vue$/,/ . md$/]// u2190 Address MD files as Vue elements. ),.+ vueMd(/ * Options */)// u2190 Organize MD files to Vue elements.]// ...To put together a Vue.js codeblock as a Demonstration Block, add demo alongside the language label:."' vue trial.
Click me."'( end).Multi-file trials.The entry purpose for trial blocks should be actually a Vue.js part. However you may import other code blocks out in any language from the exact same Fall data.For non-entry reports, set a report name by means of demonstration=. At that point bring in it from the Vue.js demo block through the doc: procedure:.
Click me.
2nd documents:.trial= click-handler. js.export const clickHandler = () => sharp(' Clicked on!').Demo + Code shuts out.Because the code blocks are actually provided inline, they are actually switched out by the true Vue.js part. To present the code block, you may incorporate a onDemo callback to the plugin alternatives:.( onDemo( componentTag, code) // Register the cover element.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Profits a customized HTML strand.return '.$ componentTag
$ this.escapeHtml( code)'. ).Alternatives.consist of.Type: ReadonlyArray|string|RegExp.Files to feature coming from being organized as Vue data.omit.Type: ReadonlyArray|chain|RegExp.Documents to omit from being actually put together as Vue data.markdownItOptions.Kind: markdownIt.Options.MarkdownIt alternatives. Visit MarkdownIt's paperwork to learn more.markdownItSetup.Style: (md: markdownIt) => space.Callback to include plugins to MarkdownIt.wrapperClass.Style: strand.Default: markdown-body.The class to contribute to the wrapper component that contains the Markdown web page.onDemo.Type:.(.tag: string,.code: cord,.trials: Map.) => cord.You can intercept each trial block as well as come back a personalized HTML strand. This is useful for incorporating custom-made designing to trial blocks.On top of that, there are actually utils subjected in the this context:.escapeHtml: Getaway HTML code to prevent it from being rendered as HTML.registerComponent: Sign up a part to become made use of in the trial block. This is useful for signing up components that are actually imported from other reports.Observe instance over in the Demonstration Blocks segment.markdownCss.Kind: chain.Submit pathway to a stylesheet to use for the Fall page. This will certainly be incorporated utilizing so it is going to simply put on the markdown webpage. Helpful for styling merely the HTML created by the MarkdownIt plugin.useVOnce.Kind: boolean.Whether to include v-once to the whole entire Accounting allowance webpage. This will prevent the Fall webpage coming from being re-rendered when the Vue element is upgraded.Caution: This will disable demonstration blocks. Merely use this if you have a large documentation as well as don't need to have demonstration blocks.Connected.unplugin-vue-markdown.An additional Vite plugin for putting together Fall reports to Vue components.This plugin has attracted inspiration coming from it however has a different component collection. This plugin just assists Vue.js code in code blocks.Github.View Github.