.This Vite plugin includes help for importing a Markdown report as a Vue part. Works along with Vue 2 & 3.Vue.js Demonstration Blocks.Make your Vue.js code blocks out inline through merely including demonstration beside the foreign language name.As an example, when this Markdown report is left using this plugin, you'll observe a clickable switch listed here:."' vue demonstration.
Click me."'( end).Install.npm set up -D vite-vue-md.Create.In your vite.config.js report:.Bring in vite-vue-md as well as add it to the plugins assortment.In your vue() plugin possibilities, include an include choice that includes.md data.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 Address MD documents as Vue components. ),.+ vueMd(/ * Options */)// u2190 Organize MD files to Vue parts.]// ...To put together a Vue.js codeblock as a Demonstration Block, include demo next to the language name:."' vue trial.
Click me."'( end).Multi-file demonstrations.The access aim for demonstration blocks need to be a Vue.js component. Yet you can easily import other code blocks out in any sort of language coming from the same Accounting allowance documents.For non-entry reports, placed a file title through demonstration=. Then import it coming from the Vue.js demo block using the doctor: protocol:.
Click me.
2nd documents:.trial= click-handler. js.export const clickHandler = () => alert(' Clicked on!').Demonstration + Code shuts out.Because the code blocks are rendered inline, they're changed due to the true Vue.js part. To present 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').// Come back a custom-made HTML cord.profit '.$ componentTag
$ this.escapeHtml( code)'. ).Possibilities.consist of.Style: ReadonlyArray|chain|RegExp.Files to feature from being actually organized as Vue reports.omit.Type: ReadonlyArray|chain|RegExp.Files to omit from being actually organized as Vue files.markdownItOptions.Style: markdownIt.Options.MarkdownIt options. See MarkdownIt's documentation to learn more.markdownItSetup.Kind: (md: markdownIt) => void.Callback to include plugins to MarkdownIt.wrapperClass.Kind: cord.Nonpayment: markdown-body.The class to include in the cover factor that contains the Markdown page.onDemo.Style:.(.tag: string,.code: cord,.trials: Chart.) => cord.You can easily obstruct each demonstration block and return a personalized HTML cord. This serves for including custom designing to demo blocks.On top of that, there are utils exposed in the this context:.escapeHtml: Breaking away HTML code to prevent it coming from being actually left as HTML.registerComponent: Register an element to be made use of in the trial block. This serves for enrolling parts that are actually imported from other data.See instance above in the Trial Blocks part.markdownCss.Type: string.Submit pathway to a stylesheet to use for the Fall web page. This will definitely be incorporated making use of so it will only apply to the markdown web page. Valuable for designating only the HTML created by the MarkdownIt plugin.useVOnce.Type: boolean.Whether to incorporate v-once to the whole Accounting allowance webpage. This will definitely protect against the Fall web page from being actually re-rendered when the Vue part is actually upgraded.Alert: This will certainly turn off demo blocks. Simply use this if you possess a big documentation and also don't need demonstration blocks.Related.unplugin-vue-markdown.One more Vite plugin for compiling Accounting allowance files to Vue parts.This plugin has pulled motivation coming from it yet has a different function collection. This plugin just supports Vue.js code in code blocks.Github.Viewpoint Github.