.This Vite plugin includes support for importing a Fall report as a Vue component. Performs with Vue 2 & 3.Vue.js Demonstration Blocks.Render your Vue.js code blocks inline through simply adding demonstration beside the foreign language title.For instance, when this Markdown file is made using this plugin, you'll find a clickable button below:."' vue demonstration.
Click me."'( end).Mount.npm set up -D vite-vue-md.Create.In your vite.config.js file:.Import vite-vue-md and incorporate it to the plugins array.In your vue() plugin options, add a consist of possibility that includes.md reports.vite.config.js:.import vue from '@vitejs/ plugin-vue'.+ import vueMd from 'vite-vue-md'.export nonpayment plugins: [// ...vue( + consist of: [/. vue$/,/ . md$/]// u2190 Treat MD data as Vue components. ),.+ vueMd(/ * Options */)// u2190 Compile MD files to Vue elements.]// ...To put together a Vue.js codeblock as a Demonstration Block, include trial beside the language label:."' vue demonstration.
Click me."'( end).Multi-file demos.The access aim for trial blocks have to be a Vue.js part. Yet you can import various other code blocks in any language from the very same Markdown report.For non-entry reports, set a data name by means of demo=. Then bring in it coming from the Vue.js trial block through the doc: process:.
Click me.
Second documents:.trial= click-handler. js.export const clickHandler = () => sharp(' Clicked!').Demonstration + Code blocks out.Since the code blocks are made inline, they are actually substituted due to the genuine Vue.js part. To present the code block, you may incorporate a onDemo callback to the plugin choices:.( onDemo( componentTag, code) // Register the cover element.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Profits a personalized HTML string.return '.$ componentTag
$ this.escapeHtml( code)'. ).Possibilities.feature.Style: ReadonlyArray|string|RegExp.Documents to include from being compiled as Vue files.omit.Type: ReadonlyArray|chain|RegExp.Data to exclude from being actually compiled as Vue documents.markdownItOptions.Style: markdownIt.Options.MarkdownIt options. Visit MarkdownIt's documents for more details.markdownItSetup.Style: (md: markdownIt) => gap.Callback to incorporate plugins to MarkdownIt.wrapperClass.Kind: strand.Nonpayment: markdown-body.The lesson to include in the wrapper factor which contains the Markdown page.onDemo.Type:.(.tag: cord,.code: strand,.demos: Map.) => strand.You can intercept each trial block and also return a custom HTML string. This is useful for incorporating customized designing to demonstration blocks.Moreover, there are utils exposed in the this context:.escapeHtml: Retreat HTML code to stop it from being rendered as HTML.registerComponent: Register a component to become made use of in the demo block. This works for registering components that are actually imported coming from other data.Find example above in the Demonstration Blocks part.markdownCss.Kind: string.File course to a stylesheet to utilize for the Markdown page. This will certainly be actually incorporated making use of so it is going to only put on the accounting allowance webpage. Useful for designating simply the HTML created due to the MarkdownIt plugin.useVOnce.Kind: boolean.Whether to add v-once to the whole entire Fall webpage. This will certainly prevent the Accounting allowance webpage coming from being actually re-rendered when the Vue component is actually updated.Alert: This are going to turn off demonstration blocks. Merely use this if you have a large paper and don't need trial blocks.Associated.unplugin-vue-markdown.Another Vite plugin for collecting Markdown files to Vue components.This plugin has pulled ideas from it but possesses a different attribute set. This plugin simply assists Vue.js code in code blocks.Github.Scenery Github.