.This Vite plugin incorporates support for importing an Accounting allowance documents as a Vue component. Works with Vue 2 & 3.Vue.js Demo Blocks.Render your Vue.js code blocks inline by simply including demo beside the foreign language title.For instance, when this Fall report is actually rendered with this plugin, you'll view a clickable switch right here:."' vue trial.
Click me."'( end).Install.npm put in -D vite-vue-md.Create.In your vite.config.js data:.Import vite-vue-md and also add it to the plugins array.In your vue() plugin options, incorporate a consist of choice that includes.md files.vite.config.js:.import vue coming from '@vitejs/ plugin-vue'.+ import vueMd from 'vite-vue-md'.export nonpayment plugins: [// ...vue( + feature: [/. vue$/,/ . md$/]// u2190 Alleviate MD reports as Vue components. ),.+ vueMd(/ * Options */)// u2190 Organize MD reports to Vue components.]// ...To collect a Vue.js codeblock as a Demo Block, include demonstration alongside the language label:."' vue trial.
Click me."'( end).Multi-file trials.The admittance objective for demo blocks should be actually a Vue.js component. But you may import various other code shuts out in any sort of foreign language from the same Markdown report.For non-entry reports, established a documents name by means of demonstration=. After that import it coming from the Vue.js demo block via the doc: procedure:.
Click me.
Second data:.trial= click-handler. js.export const clickHandler = () => alert(' Clicked on!').Demo + Code blocks out.Given that the code blocks are actually provided inline, they are actually changed due to the actual Vue.js part. To present the code block, you can include a onDemo callback to the plugin possibilities:.( onDemo( componentTag, code) // Register the wrapper element.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Come back a customized HTML string.return '.$ componentTag
$ this.escapeHtml( code)'. ).Choices.include.Type: ReadonlyArray|chain|RegExp.Data to include from being actually collected as Vue reports.leave out.Kind: ReadonlyArray|chain|RegExp.Reports to leave out from being actually collected as Vue documents.markdownItOptions.Type: markdownIt.Options.MarkdownIt options. Visit MarkdownIt's paperwork for more details.markdownItSetup.Type: (md: markdownIt) => gap.Callback to incorporate plugins to MarkdownIt.wrapperClass.Kind: strand.Default: markdown-body.The class to contribute to the wrapper element that contains the Markdown page.onDemo.Style:.(.tag: strand,.code: string,.demonstrations: Chart.) => strand.You can intercept each trial block and return a customized HTML cord. This works for adding custom styling to demo blocks.Furthermore, there are actually utils subjected in the this context:.escapeHtml: Escape HTML code to prevent it from being made as HTML.registerComponent: Register a component to be utilized in the demonstration block. This serves for registering elements that are actually imported from other files.Observe instance above in the Trial Blocks part.markdownCss.Kind: chain.Submit road to a stylesheet to make use of for the Markdown page. This will definitely be added utilizing so it will only apply to the accounting allowance web page. Useful for styling merely the HTML generated by the MarkdownIt plugin.useVOnce.Kind: boolean.Whether to include v-once to the whole Fall webpage. This will definitely protect against the Accounting allowance web page from being re-rendered when the Vue part is updated.Warning: This will turn off demonstration blocks. Simply utilize this if you possess a sizable file as well as do not require trial blocks.Related.unplugin-vue-markdown.One more Vite plugin for putting together Markdown reports to Vue elements.This plugin has pulled motivation coming from it yet has a different feature collection. This plugin just sustains Vue.js code in code blocks.Github.Viewpoint Github.