.This Vite plugin includes support for importing a Fall report as a Vue component. Performs with Vue 2 & 3.Vue.js Trial Blocks.Provide your Vue.js code blocks out inline through merely incorporating demonstration alongside the language title.For instance, when this Fall report is rendered through this plugin, you'll find a clickable switch below:."' vue demo.
Click me."'( end).Set up.npm mount -D vite-vue-md.Create.In your vite.config.js documents:.Import vite-vue-md and also incorporate it to the plugins selection.In your vue() plugin alternatives, add a consist of alternative that includes.md documents.vite.config.js:.import vue coming from '@vitejs/ plugin-vue'.+ import vueMd coming from 'vite-vue-md'.export default plugins: [// ...vue( + include: [/. vue$/,/ . md$/]// u2190 Treat MD files as Vue elements. ),.+ vueMd(/ * Options */)// u2190 Organize MD reports to Vue parts.]// ...To put together a Vue.js codeblock as a Trial Block, include trial next to the foreign language name:."' vue demonstration.
Click me."'( end).Multi-file demos.The admittance point for demonstration blocks have to be actually a Vue.js part. Yet you can easily import various other code blocks out in any foreign language coming from the exact same Markdown report.For non-entry reports, established a file name using demonstration=. After that import it coming from the Vue.js demonstration block by means of the doctor: procedure:.
Click me.
Second file:.demo= click-handler. js.export const clickHandler = () => sharp(' Clicked!').Trial + Code obstructs.Since the code blocks are made inline, they're substituted by the real Vue.js part. To reveal the code block, you may include a onDemo callback to the plugin options:.( onDemo( componentTag, code) // Sign up the cover part.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Profits a personalized HTML cord.yield '.$ componentTag
$ this.escapeHtml( code)'. ).Possibilities.feature.Style: ReadonlyArray|chain|RegExp.Reports to feature from being organized as Vue documents.exclude.Kind: ReadonlyArray|chain|RegExp.Data to exclude coming from being actually put together as Vue documents.markdownItOptions.Kind: markdownIt.Options.MarkdownIt choices. Go to MarkdownIt's information for additional information.markdownItSetup.Type: (md: markdownIt) => gap.Callback to include plugins to MarkdownIt.wrapperClass.Style: string.Default: markdown-body.The training class to include in the wrapper component that contains the Markdown page.onDemo.Type:.(.tag: cord,.code: string,.trials: Map.) => strand.You may intercept each demonstration block and come back a customized HTML cord. This serves for adding custom styling to trial blocks.Moreover, there are actually utils left open in the this context:.escapeHtml: Breaking away HTML code to prevent it from being made as HTML.registerComponent: Sign up a part to become utilized in the demo block. This works for signing up components that are imported from various other files.See instance above in the Demonstration Blocks area.markdownCss.Type: string.File pathway to a stylesheet to use for the Fall webpage. This will definitely be actually added using so it will simply relate to the markdown webpage. Beneficial for styling only the HTML produced by the MarkdownIt plugin.useVOnce.Kind: boolean.Whether to include v-once to the entire Markdown webpage. This are going to avoid the Fall web page from being re-rendered when the Vue element is upgraded.Precaution: This will definitely disable trial blocks. Only utilize this if you possess a sizable file and also do not require demo blocks.Related.unplugin-vue-markdown.Another Vite plugin for putting together Markdown reports to Vue parts.This plugin has actually attracted motivation coming from it however has a different feature collection. This plugin just assists Vue.js code in code blocks.Github.Scenery Github.