.This Vite plugin includes support for importing a Fall documents as a Vue component. Performs along with Vue 2 & 3.Vue.js Demo Blocks.Leave your Vue.js code blocks out inline through simply incorporating demo next to the foreign language label.For instance, when this Markdown file is provided through this plugin, you'll observe a clickable switch right here:."' vue demo.
Click me."'( end).Put in.npm set up -D vite-vue-md.Create.In your vite.config.js file:.Import vite-vue-md and incorporate it to the plugins variety.In your vue() plugin options, add an include option that includes.md data.vite.config.js:.bring in vue coming from '@vitejs/ plugin-vue'.+ import vueMd coming from 'vite-vue-md'.export default plugins: [// ...vue( + feature: [/. vue$/,/ . md$/]// u2190 Treat MD data as Vue components. ),.+ vueMd(/ * Options */)// u2190 Collect MD documents to Vue parts.]// ...To assemble a Vue.js codeblock as a Demo Block, add demonstration next to the language label:."' vue demonstration.
Click me."'( end).Multi-file demos.The admittance purpose for trial blocks should be actually a Vue.js part. Yet you may import various other code obstructs in any type of language coming from the very same Markdown file.For non-entry documents, set a report title by means of demonstration=. Then bring in it from the Vue.js demonstration block using the doc: method:.
Click me.
2nd data:.demo= click-handler. js.export const clickHandler = () => alert(' Clicked on!').Trial + Code blocks out.Since the code blocks are rendered inline, they are actually substituted due to the actual Vue.js part. To show the code block, you can incorporate a onDemo callback to the plugin possibilities:.( onDemo( componentTag, code) // Sign up the wrapper component.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Return a customized HTML strand.gain '.$ componentTag
$ this.escapeHtml( code)'. ).Alternatives.feature.Type: ReadonlyArray|chain|RegExp.Data to feature from being actually collected as Vue documents.omit.Kind: ReadonlyArray|chain|RegExp.Reports to exclude coming from being actually collected as Vue documents.markdownItOptions.Style: markdownIt.Options.MarkdownIt options. Visit MarkdownIt's information to find out more.markdownItSetup.Kind: (md: markdownIt) => void.Callback to include plugins to MarkdownIt.wrapperClass.Kind: cord.Nonpayment: markdown-body.The lesson to add to the cover aspect that contains the Markdown web page.onDemo.Style:.(.tag: strand,.code: strand,.demonstrations: Chart.) => string.You can intercept each demo block as well as come back a personalized HTML string. This works for adding customized designing to trial blocks.Moreover, there are actually utils subjected in the this situation:.escapeHtml: Retreat HTML code to prevent it coming from being actually provided as HTML.registerComponent: Sign up a part to become utilized in the demonstration block. This works for enrolling parts that are imported coming from other files.View example above in the Demo Blocks part.markdownCss.Type: string.File path to a stylesheet to make use of for the Fall web page. This will be added making use of so it is going to just apply to the markdown webpage. Useful for styling merely the HTML generated due to the MarkdownIt plugin.useVOnce.Type: boolean.Whether to add v-once to the entire Fall webpage. This will certainly avoid the Fall page from being re-rendered when the Vue element is actually improved.Caution: This will disable demonstration blocks. Just use this if you possess a large documentation as well as do not require demonstration blocks.Connected.unplugin-vue-markdown.Another Vite plugin for organizing Accounting allowance reports to Vue parts.This plugin has actually attracted creativity coming from it however possesses a various component set. This plugin just assists Vue.js code in code blocks.Github.Perspective Github.