.This Vite plugin adds assistance for importing a Markdown data as a Vue part. Functions along with Vue 2 & 3.Vue.js Demo Blocks.Leave your Vue.js code blocks out inline by simply incorporating demo close to the language title.For instance, when this Fall documents is actually provided through this plugin, you'll find a clickable switch listed here:."' vue trial.
Click me."'( end).Set up.npm put up -D vite-vue-md.Setup.In your vite.config.js data:.Import vite-vue-md and also incorporate it to the plugins assortment.In your vue() plugin options, incorporate a feature possibility that includes.md reports.vite.config.js:.import vue coming from '@vitejs/ plugin-vue'.+ bring in vueMd coming from 'vite-vue-md'.export default plugins: [// ...vue( + feature: [/. vue$/,/ . md$/]// u2190 Treat MD data as Vue parts. ),.+ vueMd(/ * Options */)// u2190 Organize MD data to Vue elements.]// ...To compile a Vue.js codeblock as a Demo Block, include demonstration next to the language label:."' vue trial.
Click me."'( end).Multi-file demos.The admittance aim for demonstration blocks must be actually a Vue.js component. Yet you can import other code obstructs in any sort of language from the exact same Accounting allowance documents.For non-entry reports, set a report label via demo=. At that point bring in it coming from the Vue.js trial block by means of the doc: protocol:.
Click me.
2nd data:.trial= click-handler. js.export const clickHandler = () => sharp(' Clicked on!').Trial + Code shuts out.Due to the fact that the code blocks are made inline, they're substituted by the actual Vue.js component. To show the code block, you can incorporate a onDemo callback to the plugin choices:.( onDemo( componentTag, code) // Register the wrapper part.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Come back a customized HTML cord.profit '.$ componentTag
$ this.escapeHtml( code)'. ).Alternatives.include.Kind: ReadonlyArray|string|RegExp.Data to feature from being actually assembled as Vue files.omit.Type: ReadonlyArray|string|RegExp.Data to omit from being compiled as Vue reports.markdownItOptions.Kind: markdownIt.Options.MarkdownIt choices. Go to MarkdownIt's paperwork to read more.markdownItSetup.Style: (md: markdownIt) => space.Callback to add plugins to MarkdownIt.wrapperClass.Kind: strand.Default: markdown-body.The lesson to contribute to the wrapper aspect that contains the Accounting allowance webpage.onDemo.Kind:.(.tag: string,.code: cord,.demonstrations: Map.) => strand.You can easily intercept each trial block and come back a customized HTML cord. This serves for including custom-made designing to demo blocks.Additionally, there are actually utils subjected in the this context:.escapeHtml: Retreat HTML code to avoid it coming from being actually rendered as HTML.registerComponent: Register an element to become used in the demo block. This works for signing up elements that are actually imported coming from various other documents.See example over in the Trial Blocks section.markdownCss.Type: chain.File path to a stylesheet to make use of for the Accounting allowance page. This are going to be incorporated using so it will just apply to the fall web page. Useful for styling just the HTML created by the MarkdownIt plugin.useVOnce.Kind: boolean.Whether to incorporate v-once to the entire Markdown web page. This will certainly avoid the Fall webpage from being re-rendered when the Vue component is improved.Caution: This will certainly turn off demo blocks. Simply use this if you have a big file and also do not need demonstration blocks.Related.unplugin-vue-markdown.Yet another Vite plugin for organizing Accounting allowance files to Vue elements.This plugin has attracted creativity coming from it however possesses a various attribute set. This plugin just supports Vue.js code in code blocks.Github.Perspective Github.