.This Vite plugin includes help for importing a Fall documents as a Vue part. Works with Vue 2 & 3.Vue.js Demonstration Blocks.Render your Vue.js code obstructs inline through merely including demonstration beside the language label.For example, when this Accounting allowance data is actually left through this plugin, you'll observe a clickable switch right here:."' vue trial.
Click me."'( end).Set up.npm mount -D vite-vue-md.Setup.In your vite.config.js report:.Bring in vite-vue-md as well as add it to the plugins variety.In your vue() plugin alternatives, include a feature alternative that includes.md documents.vite.config.js:.import vue from '@vitejs/ plugin-vue'.+ import vueMd coming from 'vite-vue-md'.export default plugins: [// ...vue( + include: [/. vue$/,/ . md$/]// u2190 Manage MD data as Vue parts. ),.+ vueMd(/ * Options */)// u2190 Collect MD documents to Vue components.]// ...To put together a Vue.js codeblock as a Demonstration Block, include demonstration alongside the language title:."' vue demo.
Click me."'( end).Multi-file demos.The admittance purpose for trial blocks must be a Vue.js component. But you may import other code obstructs in any kind of language coming from the very same Accounting allowance data.For non-entry files, established a data label via demo=. After that import it coming from the Vue.js trial block by means of the doc: process:.
Click me.
2nd report:.demonstration= click-handler. js.export const clickHandler = () => sharp(' Clicked!').Demo + Code obstructs.Since the code blocks are delivered inline, they are actually substituted by the actual Vue.js component. To present the code block, you can easily add a onDemo callback to the plugin alternatives:.( onDemo( componentTag, code) // Register the cover component.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Profits a customized HTML strand.yield '.$ componentTag
$ this.escapeHtml( code)'. ).Choices.include.Style: ReadonlyArray|string|RegExp.Data to feature from being collected as Vue files.omit.Type: ReadonlyArray|string|RegExp.Reports to leave out from being assembled as Vue data.markdownItOptions.Kind: markdownIt.Options.MarkdownIt options. See MarkdownIt's records to find out more.markdownItSetup.Kind: (md: markdownIt) => gap.Callback to incorporate plugins to MarkdownIt.wrapperClass.Type: strand.Nonpayment: markdown-body.The course to add to the cover element that contains the Accounting allowance web page.onDemo.Style:.(.tag: string,.code: strand,.demonstrations: Map.) => cord.You can obstruct each demo block and also come back a customized HTML strand. This works for incorporating custom styling to demonstration blocks.Moreover, there are actually utils subjected in the this circumstance:.escapeHtml: Getaway HTML code to stop it coming from being made as HTML.registerComponent: Register a component to be made use of in the demo block. This serves for signing up components that are actually imported coming from various other data.See instance over in the Demo Blocks part.markdownCss.Style: chain.File path to a stylesheet to use for the Fall webpage. This will certainly be included making use of so it will just put on the fall webpage. Practical for styling only the HTML created due to the MarkdownIt plugin.useVOnce.Type: boolean.Whether to add v-once to the whole entire Markdown web page. This will certainly avoid the Accounting allowance web page coming from being re-rendered when the Vue component is actually upgraded.Alert: This will disable trial blocks. Just use this if you have a huge documentation and do not need trial blocks.Connected.unplugin-vue-markdown.One more Vite plugin for organizing Markdown files to Vue parts.This plugin has actually attracted inspiration from it however possesses a various feature set. This plugin simply supports Vue.js code in code blocks.Github.Sight Github.