.This Vite plugin adds assistance for importing a Fall report as a Vue element. Works with Vue 2 & 3.Vue.js Trial Blocks.Leave your Vue.js code obstructs inline through simply adding trial next to the language name.As an example, when this Markdown documents is left with this plugin, you'll see a clickable button below:."' vue demonstration.
Click me."'( end).Set up.npm mount -D vite-vue-md.Create.In your vite.config.js documents:.Import vite-vue-md as well as include it to the plugins assortment.In your vue() plugin choices, incorporate a consist of choice that includes.md reports.vite.config.js:.import vue coming from '@vitejs/ plugin-vue'.+ import vueMd from 'vite-vue-md'.export nonpayment plugins: [// ...vue( + consist of: [/. vue$/,/ . md$/]// u2190 Manage MD documents as Vue elements. ),.+ vueMd(/ * Options */)// u2190 Compile MD reports to Vue elements.]// ...To assemble a Vue.js codeblock as a Trial Block, incorporate trial next to the foreign language label:."' vue demonstration.
Click me."'( end).Multi-file demonstrations.The entry point for demo blocks should be a Vue.js element. However you may import other code blocks in any type of language from the same Markdown file.For non-entry reports, set a file title using demonstration=. Then import it coming from the Vue.js demo block through the doc: procedure:.
Click me.
Second documents:.trial= click-handler. js.export const clickHandler = () => sharp(' Clicked!').Trial + Code shuts out.Since the code blocks are rendered inline, they are actually switched out by the genuine Vue.js element. To show the code block, you can add a onDemo callback to the plugin options:.( onDemo( componentTag, code) // Register the cover part.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Profits a custom HTML string.gain '.$ componentTag
$ this.escapeHtml( code)'. ).Choices.include.Style: ReadonlyArray|string|RegExp.Reports to include from being put together as Vue data.omit.Type: ReadonlyArray|string|RegExp.Reports to exclude coming from being compiled as Vue files.markdownItOptions.Kind: markdownIt.Options.MarkdownIt choices. Go to MarkdownIt's documents to read more.markdownItSetup.Style: (md: markdownIt) => gap.Callback to include plugins to MarkdownIt.wrapperClass.Style: cord.Default: markdown-body.The class to contribute to the wrapper factor that contains the Accounting allowance webpage.onDemo.Kind:.(.tag: strand,.code: cord,.demonstrations: Chart.) => strand.You can easily intercept each trial block and also come back a customized HTML cord. This works for incorporating personalized styling to trial blocks.In addition, there are actually utils left open in the this situation:.escapeHtml: Breaking away HTML code to prevent it coming from being provided as HTML.registerComponent: Sign up a part to become used in the demo block. This serves for registering elements that are imported coming from various other files.See instance above in the Trial Blocks part.markdownCss.Style: string.Submit pathway to a stylesheet to make use of for the Markdown web page. This are going to be actually added making use of so it will just put on the fall web page. Valuable for styling only the HTML created by the MarkdownIt plugin.useVOnce.Type: boolean.Whether to add v-once to the entire Fall web page. This are going to stop the Markdown webpage coming from being re-rendered when the Vue part is actually updated.Caution: This will certainly turn off trial blocks. Just utilize this if you have a sizable record and don't need to have demo blocks.Related.unplugin-vue-markdown.An additional Vite plugin for organizing Markdown reports to Vue elements.This plugin has attracted ideas from it but has a different attribute set. This plugin merely supports Vue.js code in code blocks.Github.Perspective Github.