.This Vite plugin incorporates support for importing a Markdown file as a Vue element. Performs along with Vue 2 & 3.Vue.js Demonstration Blocks.Render your Vue.js code blocks inline through just adding demonstration beside the foreign language title.For example, when this Fall file is rendered through this plugin, you'll observe a clickable button right here:."' vue demonstration.
Click me."'( end).Mount.npm put in -D vite-vue-md.Create.In your vite.config.js report:.Import vite-vue-md as well as add it to the plugins assortment.In your vue() plugin choices, incorporate a feature option that includes.md documents.vite.config.js:.bring in vue coming from '@vitejs/ plugin-vue'.+ import vueMd coming from 'vite-vue-md'.export nonpayment plugins: [// ...vue( + feature: [/. vue$/,/ . md$/]// u2190 Handle MD files as Vue elements. ),.+ vueMd(/ * Options */)// u2190 Put together MD files to Vue elements.]// ...To collect a Vue.js codeblock as a Trial Block, include demonstration next to the language title:."' vue trial.
Click me."'( end).Multi-file demos.The admittance purpose for trial blocks must be actually a Vue.js part. However you can import various other code obstructs in any sort of foreign language from the very same Markdown report.For non-entry reports, established a file name using demonstration=. Then bring in it from the Vue.js trial block through the doctor: protocol:.
Click me.
2nd data:.trial= click-handler. js.export const clickHandler = () => sharp(' Clicked!').Trial + Code shuts out.Due to the fact that the code blocks are rendered inline, they are actually replaced due to the true Vue.js element. To present the code block, you can easily add a onDemo callback to the plugin alternatives:.( onDemo( componentTag, code) // Sign up the wrapper component.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Come back a custom-made HTML strand.yield '.$ componentTag
$ this.escapeHtml( code)'. ).Options.feature.Kind: ReadonlyArray|string|RegExp.Documents to include coming from being actually organized as Vue documents.leave out.Style: ReadonlyArray|string|RegExp.Documents to exclude from being collected as Vue files.markdownItOptions.Kind: markdownIt.Options.MarkdownIt options. Check out MarkdownIt's documentation for additional information.markdownItSetup.Kind: (md: markdownIt) => space.Callback to include plugins to MarkdownIt.wrapperClass.Kind: cord.Nonpayment: markdown-body.The class to add to the wrapper element that contains the Fall web page.onDemo.Style:.(.tag: string,.code: string,.trials: Chart.) => cord.You may obstruct each demonstration block and return a custom-made HTML string. This is useful for including custom-made styling to trial blocks.Furthermore, there are utils subjected in the this circumstance:.escapeHtml: Retreat HTML code to avoid it coming from being actually provided as HTML.registerComponent: Register a component to be made use of in the trial block. This works for signing up parts that are imported from other data.View example over in the Trial Blocks section.markdownCss.Kind: chain.File road to a stylesheet to use for the Fall webpage. This are going to be actually incorporated making use of so it will just put on the accounting allowance web page. Valuable for styling just the HTML created by the MarkdownIt plugin.useVOnce.Type: boolean.Whether to incorporate v-once to the entire Accounting allowance web page. This are going to avoid the Fall webpage coming from being actually re-rendered when the Vue element is upgraded.Alert: This will turn off trial blocks. Simply use this if you possess a sizable paper as well as do not require demonstration blocks.Associated.unplugin-vue-markdown.One more Vite plugin for assembling Accounting allowance reports to Vue elements.This plugin has actually drawn ideas coming from it however has a different feature set. This plugin simply sustains Vue.js code in code blocks.Github.Viewpoint Github.