.This Vite plugin includes help for importing a Markdown data as a Vue part. Works with Vue 2 & 3.Vue.js Demonstration Blocks.Render your Vue.js code blocks out inline by merely incorporating demonstration beside the language title.For instance, when this Fall report is left with this plugin, you'll observe a clickable button listed here:."' vue trial.
Click me."'( end).Install.npm install -D vite-vue-md.Setup.In your vite.config.js file:.Bring in vite-vue-md and incorporate it to the plugins array.In your vue() plugin possibilities, add a consist of alternative that includes.md files.vite.config.js:.import vue coming from '@vitejs/ plugin-vue'.+ import vueMd from 'vite-vue-md'.export default plugins: [// ...vue( + feature: [/. vue$/,/ . md$/]// u2190 Handle MD data as Vue parts. ),.+ vueMd(/ * Options */)// u2190 Collect MD files to Vue parts.]// ...To assemble a Vue.js codeblock as a Demonstration Block, incorporate demo beside the language name:."' vue trial.
Click me."'( end).Multi-file trials.The entry point for demonstration blocks need to be a Vue.js element. However you can import other code blocks out in any foreign language from the same Fall data.For non-entry reports, placed a file label through trial=. Then import it from the Vue.js demo block via the doctor: method:.
Click me.
Second documents:.demo= click-handler. js.export const clickHandler = () => alert(' Clicked on!').Demo + Code blocks.Considering that the code blocks are delivered inline, they're replaced due to the real Vue.js element. To present the code block, you may add a onDemo callback to the plugin options:.( onDemo( componentTag, code) // Register the wrapper element.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Return a custom-made HTML string.gain '.$ componentTag
$ this.escapeHtml( code)'. ).Options.include.Kind: ReadonlyArray|string|RegExp.Documents to consist of coming from being actually assembled as Vue files.leave out.Style: ReadonlyArray|string|RegExp.Documents to omit coming from being actually compiled as Vue data.markdownItOptions.Type: markdownIt.Options.MarkdownIt options. Go to MarkdownIt's records to read more.markdownItSetup.Style: (md: markdownIt) => space.Callback to incorporate plugins to MarkdownIt.wrapperClass.Kind: string.Default: markdown-body.The lesson to add to the cover element that contains the Accounting allowance page.onDemo.Style:.(.tag: string,.code: string,.demos: Map.) => string.You can obstruct each demo block as well as come back a custom-made HTML string. This serves for incorporating custom-made designing to demo blocks.In addition, there are utils subjected in the this context:.escapeHtml: Escape HTML code to prevent it from being left as HTML.registerComponent: Register an element to become made use of in the demo block. This works for registering parts that are actually imported coming from various other data.View example over in the Demo Blocks part.markdownCss.Style: string.Submit course to a stylesheet to utilize for the Fall page. This will definitely be actually included utilizing so it will simply put on the accounting allowance webpage. Practical for designating only the HTML produced due to the MarkdownIt plugin.useVOnce.Type: boolean.Whether to add v-once to the whole entire Accounting allowance webpage. This will certainly stop the Fall page from being re-rendered when the Vue element is improved.Caution: This will certainly disable demonstration blocks. Merely use this if you possess a large record as well as don't need to have demo blocks.Associated.unplugin-vue-markdown.One more Vite plugin for putting together Markdown data to Vue elements.This plugin has actually attracted inspiration coming from it but possesses a various function collection. This plugin just assists Vue.js code in code blocks.Github.Scenery Github.