.This Vite plugin adds assistance for importing an Accounting allowance report as a Vue element. Functions along with Vue 2 & 3.Vue.js Demonstration Blocks.Provide your Vue.js code blocks inline through simply including trial beside the foreign language name.As an example, when this Markdown data is left with this plugin, you'll observe a clickable switch listed here:."' vue demo.
Click me."'( end).Put in.npm put up -D vite-vue-md.Setup.In your vite.config.js file:.Import vite-vue-md and also include it to the plugins selection.In your vue() plugin possibilities, add a consist of alternative that includes.md data.vite.config.js:.bring in vue coming from '@vitejs/ plugin-vue'.+ bring in vueMd coming from 'vite-vue-md'.export nonpayment plugins: [// ...vue( + feature: [/. vue$/,/ . md$/]// u2190 Handle MD documents as Vue components. ),.+ vueMd(/ * Options */)// u2190 Compile MD reports to Vue components.]// ...To assemble a Vue.js codeblock as a Trial Block, add trial next to the language title:."' vue demonstration.
Click me."'( end).Multi-file demos.The admittance objective for trial blocks need to be a Vue.js component. Yet you may import other code obstructs in any type of foreign language from the exact same Markdown report.For non-entry files, established a documents label via demo=. After that import it coming from the Vue.js demonstration block by means of the doc: procedure:.
Click me.
Second documents:.demo= click-handler. js.export const clickHandler = () => sharp(' Clicked on!').Demonstration + Code obstructs.Because the code blocks are actually made inline, they're substituted due to the true Vue.js component. To show the code block, you can incorporate a onDemo callback to the plugin options:.( onDemo( componentTag, code) // Sign up the cover part.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Return a custom HTML cord.yield '.$ componentTag
$ this.escapeHtml( code)'. ).Choices.feature.Kind: ReadonlyArray|string|RegExp.Data to include coming from being collected as Vue reports.exclude.Kind: ReadonlyArray|string|RegExp.Data to exclude coming from being actually put together as Vue data.markdownItOptions.Type: markdownIt.Options.MarkdownIt possibilities. Visit MarkdownIt's paperwork to find out more.markdownItSetup.Type: (md: markdownIt) => void.Callback to include plugins to MarkdownIt.wrapperClass.Kind: string.Nonpayment: markdown-body.The lesson to include in the wrapper component which contains the Fall webpage.onDemo.Style:.(.tag: strand,.code: cord,.trials: Chart.) => string.You can intercept each demonstration block and return a custom HTML strand. This is useful for adding custom designing to demo blocks.Additionally, there are utils left open in the this situation:.escapeHtml: Escape HTML code to stop it coming from being provided as HTML.registerComponent: Sign up a component to be utilized in the demo block. This works for signing up elements that are actually imported from various other files.See example over in the Demonstration Blocks part.markdownCss.Style: chain.File course to a stylesheet to use for the Fall webpage. This will be added making use of so it is going to only relate to the accounting allowance page. Helpful for designating merely the HTML generated by the MarkdownIt plugin.useVOnce.Kind: boolean.Whether to include v-once to the whole Markdown page. This will definitely stop the Accounting allowance webpage coming from being actually re-rendered when the Vue component is upgraded.Precaution: This will certainly turn off demo blocks. Only use this if you have a sizable documentation as well as don't require trial blocks.Related.unplugin-vue-markdown.An additional Vite plugin for collecting Accounting allowance documents to Vue components.This plugin has drawn inspiration coming from it yet possesses a various component set. This plugin only supports Vue.js code in code blocks.Github.Scenery Github.