.This Vite plugin incorporates support for importing a Markdown documents as a Vue element. Works along with Vue 2 & 3.Vue.js Demo Blocks.Provide your Vue.js code obstructs inline through simply incorporating demonstration close to the foreign language title.For instance, when this Markdown file is actually provided through this plugin, you'll see a clickable button right here:."' vue trial.
Click me."'( end).Put in.npm put up -D vite-vue-md.Create.In your vite.config.js data:.Import vite-vue-md as well as include it to the plugins range.In your vue() plugin options, include a consist of choice that includes.md data.vite.config.js:.import vue from '@vitejs/ plugin-vue'.+ import vueMd coming from 'vite-vue-md'.export nonpayment plugins: [// ...vue( + feature: [/. vue$/,/ . md$/]// u2190 Manage MD reports as Vue elements. ),.+ vueMd(/ * Options */)// u2190 Organize MD documents to Vue components.]// ...To compile a Vue.js codeblock as a Demonstration Block, add demo next to the foreign language name:."' vue trial.
Click me."'( end).Multi-file demos.The access aim for demonstration blocks should be actually a Vue.js component. But you may import various other code blocks out in any foreign language coming from the exact same Fall report.For non-entry documents, placed a report label by means of trial=. At that point bring in it coming from the Vue.js demonstration block using the doctor: process:.
Click me.
2nd data:.trial= click-handler. js.export const clickHandler = () => alert(' Clicked on!').Demo + Code blocks.Considering that the code blocks are rendered inline, they're replaced due to the true Vue.js part. To show the code block, you can add a onDemo callback to the plugin alternatives:.( onDemo( componentTag, code) // Register the cover component.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Profits a custom HTML string.gain '.$ componentTag
$ this.escapeHtml( code)'. ).Alternatives.include.Style: ReadonlyArray|string|RegExp.Reports to feature coming from being compiled as Vue files.omit.Type: ReadonlyArray|string|RegExp.Files to exclude from being compiled as Vue documents.markdownItOptions.Type: markdownIt.Options.MarkdownIt alternatives. See MarkdownIt's documents for more information.markdownItSetup.Style: (md: markdownIt) => void.Callback to incorporate plugins to MarkdownIt.wrapperClass.Type: string.Default: markdown-body.The training class to add to the cover factor which contains the Fall page.onDemo.Style:.(.tag: cord,.code: cord,.demonstrations: Map.) => cord.You can easily intercept each demo block and return a personalized HTML string. This works for incorporating custom-made styling to trial blocks.In addition, there are actually utils subjected in the this context:.escapeHtml: Retreat HTML code to avoid it from being actually made as HTML.registerComponent: Sign up a component to be made use of in the demo block. This is useful for enrolling components that are actually imported from other files.See instance over in the Demonstration Blocks part.markdownCss.Type: string.Submit road to a stylesheet to make use of for the Fall page. This are going to be incorporated utilizing so it is going to only relate to the markdown page. Helpful for styling merely the HTML created by the MarkdownIt plugin.useVOnce.Style: boolean.Whether to add v-once to the whole entire Markdown web page. This are going to stop the Fall webpage coming from being re-rendered when the Vue element is actually updated.Alert: This will definitely turn off trial blocks. Just utilize this if you possess a huge document and don't require demonstration blocks.Connected.unplugin-vue-markdown.Yet another Vite plugin for collecting Accounting allowance documents to Vue components.This plugin has drawn motivation coming from it but has a different function set. This plugin just assists Vue.js code in code blocks.Github.View Github.