.This Vite plugin adds help for importing a Markdown file as a Vue component. Performs along with Vue 2 & 3.Vue.js Trial Blocks.Leave your Vue.js code blocks out inline through simply adding demo beside the foreign language title.For instance, when this Markdown file is provided through this plugin, you'll see a clickable button below:."' vue demonstration.
Click me."'( end).Mount.npm install -D vite-vue-md.Setup.In your vite.config.js documents:.Import vite-vue-md and also include it to the plugins variety.In your vue() plugin choices, add an include choice that includes.md files.vite.config.js:.import vue coming from '@vitejs/ plugin-vue'.+ bring in vueMd from 'vite-vue-md'.export nonpayment plugins: [// ...vue( + consist of: [/. vue$/,/ . md$/]// u2190 Treat MD reports as Vue elements. ),.+ vueMd(/ * Options */)// u2190 Assemble MD documents to Vue parts.]// ...To organize a Vue.js codeblock as a Demo Block, add demonstration alongside the foreign language label:."' vue demonstration.
Click me."'( end).Multi-file trials.The entry purpose for trial blocks have to be a Vue.js component. But you can easily import various other code blocks in any foreign language coming from the exact same Accounting allowance data.For non-entry data, set a data name through demonstration=. Then import it from the Vue.js trial block through the doc: process:.
Click me.
Second file:.demo= click-handler. js.export const clickHandler = () => sharp(' Clicked!').Trial + Code blocks.Due to the fact that the code blocks are actually delivered inline, they're switched out by the real Vue.js part. To show the code block, you may incorporate a onDemo callback to the plugin options:.( onDemo( componentTag, code) // Register the cover part.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Return a personalized HTML string.return '.$ componentTag
$ this.escapeHtml( code)'. ).Choices.consist of.Type: ReadonlyArray|string|RegExp.Reports to include from being actually collected as Vue files.omit.Kind: ReadonlyArray|string|RegExp.Data to omit coming from being actually put together as Vue reports.markdownItOptions.Style: markdownIt.Options.MarkdownIt options. Visit MarkdownIt's paperwork for additional information.markdownItSetup.Style: (md: markdownIt) => space.Callback to incorporate plugins to MarkdownIt.wrapperClass.Type: cord.Default: markdown-body.The course to include in the wrapper component that contains the Markdown web page.onDemo.Style:.(.tag: strand,.code: strand,.trials: Chart.) => string.You can easily intercept each demonstration block as well as return a customized HTML string. This serves for including personalized styling to trial blocks.Additionally, there are actually utils exposed in the this context:.escapeHtml: Escape HTML code to prevent it coming from being actually made as HTML.registerComponent: Register an element to be utilized in the demonstration block. This serves for registering parts that are actually imported from various other reports.See instance above in the Demonstration Blocks segment.markdownCss.Kind: string.File pathway to a stylesheet to utilize for the Fall webpage. This will definitely be actually added using so it will merely apply to the accounting allowance webpage. Beneficial for designating simply the HTML created due to the MarkdownIt plugin.useVOnce.Type: boolean.Whether to add v-once to the whole Fall webpage. This will certainly prevent the Fall webpage coming from being actually re-rendered when the Vue element is actually updated.Warning: This will disable trial blocks. Simply use this if you possess a huge file as well as don't need demonstration blocks.Connected.unplugin-vue-markdown.An additional Vite plugin for putting together Accounting allowance files to Vue components.This plugin has drawn creativity from it but has a various feature collection. This plugin simply supports Vue.js code in code blocks.Github.Sight Github.