.This Vite plugin adds help for importing a Markdown documents as a Vue element. Works with Vue 2 & 3.Vue.js Demo Blocks.Render your Vue.js code shuts out inline by merely including demo close to the foreign language label.For example, when this Fall documents is left using this plugin, you'll view a clickable switch listed here:."' vue demo.
Click me."'( end).Install.npm put up -D vite-vue-md.Setup.In your vite.config.js report:.Import vite-vue-md and add it to the plugins selection.In your vue() plugin alternatives, incorporate an include possibility that includes.md reports.vite.config.js:.import vue from '@vitejs/ plugin-vue'.+ import vueMd coming from 'vite-vue-md'.export nonpayment plugins: [// ...vue( + include: [/. vue$/,/ . md$/]// u2190 Deal with MD data as Vue elements. ),.+ vueMd(/ * Options */)// u2190 Collect MD documents to Vue parts.]// ...To compile a Vue.js codeblock as a Demo Block, incorporate demo next to the language name:."' vue trial.
Click me."'( end).Multi-file trials.The admittance point for trial blocks need to be actually a Vue.js element. But you can easily import other code obstructs in any foreign language from the very same Fall documents.For non-entry documents, established a documents name through demo=. Then import it coming from the Vue.js demo block by means of the doc: protocol:.
Click me.
Second file:.demonstration= click-handler. js.export const clickHandler = () => sharp(' Clicked on!').Demo + Code blocks.Due to the fact that the code blocks are actually provided inline, they're substituted due to the actual Vue.js part. To show the code block, you may include a onDemo callback to the plugin possibilities:.( onDemo( componentTag, code) // Register the wrapper component.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Come back a customized HTML strand.gain '.$ componentTag
$ this.escapeHtml( code)'. ).Alternatives.feature.Kind: ReadonlyArray|chain|RegExp.Documents to include coming from being actually put together as Vue documents.omit.Type: ReadonlyArray|chain|RegExp.Data to omit coming from being organized as Vue data.markdownItOptions.Style: markdownIt.Options.MarkdownIt possibilities. Check out MarkdownIt's information to find out more.markdownItSetup.Kind: (md: markdownIt) => gap.Callback to include plugins to MarkdownIt.wrapperClass.Style: strand.Nonpayment: markdown-body.The course to add to the cover element that contains the Accounting allowance webpage.onDemo.Type:.(.tag: cord,.code: strand,.demonstrations: Chart.) => cord.You may obstruct each demonstration block and also come back a custom-made HTML cord. This serves for adding custom-made styling to demonstration blocks.Moreover, there are actually utils left open in the this context:.escapeHtml: Retreat HTML code to prevent it coming from being rendered as HTML.registerComponent: Register a part to be utilized in the trial block. This is useful for signing up elements that are actually imported coming from other files.View instance above in the Trial Blocks part.markdownCss.Kind: chain.File road to a stylesheet to make use of for the Markdown page. This will definitely be incorporated making use of so it will only relate to the fall page. Helpful for styling just the HTML created by the MarkdownIt plugin.useVOnce.Style: boolean.Whether to add v-once to the entire Markdown web page. This are going to protect against the Markdown page coming from being re-rendered when the Vue component is actually upgraded.Caution: This will definitely disable demo blocks. Just use this if you possess a huge document and don't need demonstration blocks.Associated.unplugin-vue-markdown.Yet another Vite plugin for organizing Markdown reports to Vue parts.This plugin has attracted motivation from it but possesses a different component set. This plugin simply assists Vue.js code in code blocks.Github.Perspective Github.