.This Vite plugin adds assistance for importing a Fall documents as a Vue element. Performs with Vue 2 & 3.Vue.js Trial Blocks.Leave your Vue.js code obstructs inline through merely adding demo alongside the language title.For example, when this Fall data is actually provided with this plugin, you'll find a clickable button here:."' vue demonstration.
Click me."'( end).Install.npm put in -D vite-vue-md.Setup.In your vite.config.js file:.Import vite-vue-md and add it to the plugins range.In your vue() plugin options, incorporate an include possibility that includes.md documents.vite.config.js:.bring in vue coming from '@vitejs/ plugin-vue'.+ import vueMd from 'vite-vue-md'.export default plugins: [// ...vue( + feature: [/. vue$/,/ . md$/]// u2190 Deal with MD reports as Vue parts. ),.+ vueMd(/ * Options */)// u2190 Collect MD reports to Vue parts.]// ...To organize a Vue.js codeblock as a Demonstration Block, include demo next to the language title:."' vue demo.
Click me."'( end).Multi-file demos.The admittance aim for demonstration blocks must be a Vue.js element. Yet you can easily import other code blocks in any type of foreign language coming from the same Fall data.For non-entry documents, established a data label through trial=. After that bring in it coming from the Vue.js trial block through the doc: process:.
Click me.
2nd data:.trial= click-handler. js.export const clickHandler = () => alert(' Clicked!').Demonstration + Code shuts out.Because the code blocks are delivered inline, they are actually replaced by the true Vue.js element. To show the code block, you may add a onDemo callback to the plugin possibilities:.( onDemo( componentTag, code) // Sign up the cover component.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Come back a customized HTML strand.gain '.$ componentTag
$ this.escapeHtml( code)'. ).Alternatives.feature.Style: ReadonlyArray|string|RegExp.Files to consist of coming from being actually put together as Vue files.exclude.Kind: ReadonlyArray|chain|RegExp.Reports to exclude from being put together as Vue reports.markdownItOptions.Type: markdownIt.Options.MarkdownIt possibilities. Check out MarkdownIt's records to find out more.markdownItSetup.Type: (md: markdownIt) => space.Callback to incorporate plugins to MarkdownIt.wrapperClass.Kind: strand.Default: markdown-body.The training class to contribute to the wrapper aspect that contains the Accounting allowance web page.onDemo.Style:.(.tag: cord,.code: string,.demos: Chart.) => strand.You can obstruct each demonstration block as well as come back a custom-made HTML string. This is useful for incorporating custom designing to trial blocks.Moreover, there are actually utils exposed in the this situation:.escapeHtml: Escape HTML code to avoid it from being actually provided as HTML.registerComponent: Register a component to become used in the demo block. This is useful for signing up components that are imported coming from other files.View example above in the Demonstration Blocks segment.markdownCss.Type: string.File pathway to a stylesheet to utilize for the Accounting allowance webpage. This will certainly be incorporated using so it is going to only put on the accounting allowance web page. Valuable for designating just the HTML produced by the MarkdownIt plugin.useVOnce.Type: boolean.Whether to include v-once to the whole Fall web page. This will certainly stop the Fall page from being actually re-rendered when the Vue component is improved.Caution: This will certainly disable demo blocks. Only utilize this if you have a huge documentation and also don't need to have demonstration blocks.Associated.unplugin-vue-markdown.Another Vite plugin for assembling Markdown reports to Vue elements.This plugin has pulled ideas coming from it but has a different attribute collection. This plugin simply sustains Vue.js code in code blocks.Github.Sight Github.