.This Vite plugin includes help for importing a Markdown data as a Vue part. Functions with Vue 2 & 3.Vue.js Demonstration Blocks.Provide your Vue.js code obstructs inline by just including demonstration next to the foreign language name.For example, when this Markdown documents is left with this plugin, you'll find a clickable button right here:."' vue trial.
Click me."'( end).Set up.npm mount -D vite-vue-md.Create.In your vite.config.js documents:.Bring in vite-vue-md and also add it to the plugins range.In your vue() plugin alternatives, add an include option that includes.md data.vite.config.js:.bring in vue from '@vitejs/ plugin-vue'.+ import vueMd from 'vite-vue-md'.export default plugins: [// ...vue( + feature: [/. vue$/,/ . md$/]// u2190 Treat MD files as Vue components. ),.+ vueMd(/ * Options */)// u2190 Assemble MD data to Vue elements.]// ...To put together a Vue.js codeblock as a Trial Block, incorporate demonstration beside the foreign language title:."' vue demo.
Click me."'( end).Multi-file demonstrations.The admittance aim for trial blocks should be a Vue.js component. But you may import other code shuts out in any kind of foreign language from the exact same Fall data.For non-entry reports, established a data title through trial=. After that bring in it coming from the Vue.js demo block using the doc: method:.
Click me.
2nd report:.demo= click-handler. js.export const clickHandler = () => sharp(' Clicked on!').Trial + Code obstructs.Because the code blocks are provided inline, they're substituted due to the true Vue.js element. To reveal the code block, you can easily include a onDemo callback to the plugin possibilities:.( onDemo( componentTag, code) // Register the cover component.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Return a custom HTML cord.yield '.$ componentTag
$ this.escapeHtml( code)'. ).Alternatives.include.Style: ReadonlyArray|string|RegExp.Documents to feature coming from being actually compiled as Vue documents.omit.Kind: ReadonlyArray|chain|RegExp.Reports to exclude from being actually organized as Vue files.markdownItOptions.Type: markdownIt.Options.MarkdownIt alternatives. See MarkdownIt's documentation to find out more.markdownItSetup.Kind: (md: markdownIt) => gap.Callback to incorporate plugins to MarkdownIt.wrapperClass.Kind: string.Nonpayment: markdown-body.The training class to contribute to the cover element that contains the Accounting allowance web page.onDemo.Kind:.(.tag: cord,.code: cord,.demonstrations: Chart.) => string.You can easily obstruct each demo block and also return a custom-made HTML strand. This serves for including customized styling to trial blocks.In addition, there are actually utils exposed in the this circumstance:.escapeHtml: Retreat HTML code to stop it from being left as HTML.registerComponent: Sign up a part to be utilized in the demo block. This is useful for signing up components that are actually imported from other documents.Observe example over in the Demo Blocks part.markdownCss.Style: chain.File road to a stylesheet to make use of for the Accounting allowance page. This are going to be incorporated using so it will merely put on the accounting allowance web page. Useful for designating just the HTML produced by the MarkdownIt plugin.useVOnce.Style: boolean.Whether to add v-once to the whole Fall webpage. This are going to stop the Accounting allowance page from being re-rendered when the Vue part is actually improved.Caution: This will certainly turn off demonstration blocks. Merely utilize this if you have a sizable documentation and do not require demonstration blocks.Related.unplugin-vue-markdown.Yet another Vite plugin for putting together Fall reports to Vue elements.This plugin has pulled inspiration coming from it yet possesses a various function collection. This plugin simply sustains Vue.js code in code blocks.Github.Scenery Github.