.This Vite plugin incorporates support for importing a Markdown documents as a Vue component. Functions along with Vue 2 & 3.Vue.js Trial Blocks.Provide your Vue.js code blocks inline by simply incorporating demonstration close to the foreign language label.For instance, when this Markdown data is actually left using this plugin, you'll observe a clickable button listed here:."' vue demonstration.
Click me."'( end).Install.npm set up -D vite-vue-md.Setup.In your vite.config.js data:.Bring in vite-vue-md and also incorporate it to the plugins variety.In your vue() plugin options, incorporate a feature alternative that includes.md reports.vite.config.js:.import vue coming from '@vitejs/ plugin-vue'.+ import vueMd from 'vite-vue-md'.export default plugins: [// ...vue( + feature: [/. vue$/,/ . md$/]// u2190 Manage MD data as Vue components. ),.+ vueMd(/ * Options */)// u2190 Put together MD data to Vue elements.]// ...To organize a Vue.js codeblock as a Demo Block, incorporate demonstration beside the language title:."' vue demo.
Click me."'( end).Multi-file trials.The access objective for demonstration blocks need to be a Vue.js component. However you may import various other code shuts out in any type of foreign language coming from the same Fall file.For non-entry files, placed a data name using trial=. After that import it coming from the Vue.js demonstration block through the doctor: procedure:.
Click me.
2nd file:.demonstration= click-handler. js.export const clickHandler = () => alert(' Clicked on!').Demo + Code obstructs.Due to the fact that the code blocks are delivered inline, they're switched out by the actual Vue.js component. To reveal the code block, you can easily include a onDemo callback to the plugin possibilities:.( onDemo( componentTag, code) // Register the wrapper part.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Return a customized HTML cord.gain '.$ componentTag
$ this.escapeHtml( code)'. ).Alternatives.consist of.Kind: ReadonlyArray|chain|RegExp.Data to include coming from being assembled as Vue data.leave out.Kind: ReadonlyArray|chain|RegExp.Reports to omit coming from being actually put together as Vue documents.markdownItOptions.Kind: markdownIt.Options.MarkdownIt options. Visit MarkdownIt's records for additional information.markdownItSetup.Type: (md: markdownIt) => space.Callback to incorporate plugins to MarkdownIt.wrapperClass.Kind: strand.Default: markdown-body.The class to add to the cover factor which contains the Fall page.onDemo.Kind:.(.tag: cord,.code: strand,.demos: Chart.) => cord.You may obstruct each demo block and also return a personalized HTML string. This is useful for adding customized designing to trial blocks.Moreover, there are utils subjected in the this context:.escapeHtml: Retreat HTML code to prevent it from being actually made as HTML.registerComponent: Sign up a component to become made use of in the trial block. This serves for signing up components that are imported coming from other data.Observe instance over in the Trial Blocks area.markdownCss.Kind: string.File road to a stylesheet to utilize for the Fall web page. This will definitely be actually included utilizing so it is going to merely apply to the accounting allowance web page. Useful for designating only the HTML generated due to the MarkdownIt plugin.useVOnce.Style: boolean.Whether to incorporate v-once to the whole Accounting allowance webpage. This will certainly stop the Fall page from being re-rendered when the Vue part is actually updated.Precaution: This will certainly disable demo blocks. Simply utilize this if you possess a sizable documentation and also do not need to have demonstration blocks.Related.unplugin-vue-markdown.One more Vite plugin for compiling Accounting allowance documents to Vue elements.This plugin has drawn inspiration from it but has a various attribute collection. This plugin just assists Vue.js code in code blocks.Github.Viewpoint Github.