.This Vite plugin incorporates assistance for importing a Markdown data as a Vue part. Functions with Vue 2 & 3.Vue.js Demonstration Blocks.Render your Vue.js code obstructs inline through merely incorporating demonstration beside the foreign language label.For example, when this Fall file is actually provided with this plugin, you'll view a clickable switch here:."' vue demonstration.
Click me."'( end).Mount.npm mount -D vite-vue-md.Setup.In your vite.config.js data:.Import vite-vue-md and incorporate it to the plugins selection.In your vue() plugin options, add an include choice that includes.md data.vite.config.js:.bring in vue coming from '@vitejs/ plugin-vue'.+ bring in vueMd coming from 'vite-vue-md'.export nonpayment plugins: [// ...vue( + consist of: [/. vue$/,/ . md$/]// u2190 Alleviate MD data as Vue components. ),.+ vueMd(/ * Options */)// u2190 Put together MD documents to Vue components.]// ...To put together a Vue.js codeblock as a Demonstration Block, include trial next to the language name:."' vue demonstration.
Click me."'( end).Multi-file trials.The access purpose for demonstration blocks need to be a Vue.js component. Yet you can easily import various other code obstructs in any sort of language coming from the very same Accounting allowance documents.For non-entry data, established a file title by means of demo=. At that point bring in it coming from the Vue.js demonstration block through the doc: method:.
Click me.
2nd data:.trial= click-handler. js.export const clickHandler = () => sharp(' Clicked!').Demo + Code blocks out.Due to the fact that the code blocks are actually rendered inline, they are actually switched out due to the genuine Vue.js part. To reveal the code block, you can easily add a onDemo callback to the plugin choices:.( onDemo( componentTag, code) // Register the cover element.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Profits a personalized HTML string.yield '.$ componentTag
$ this.escapeHtml( code)'. ).Alternatives.consist of.Kind: ReadonlyArray|chain|RegExp.Documents to consist of coming from being actually organized as Vue files.exclude.Kind: ReadonlyArray|chain|RegExp.Data to exclude coming from being actually compiled as Vue reports.markdownItOptions.Type: markdownIt.Options.MarkdownIt possibilities. Visit MarkdownIt's documentation for more information.markdownItSetup.Style: (md: markdownIt) => void.Callback to include plugins to MarkdownIt.wrapperClass.Type: string.Default: markdown-body.The course to add to the wrapper element that contains the Markdown web page.onDemo.Style:.(.tag: cord,.code: cord,.demos: Chart.) => strand.You can obstruct each demonstration block as well as return a personalized HTML strand. This serves for incorporating personalized designing to demo blocks.On top of that, there are actually utils exposed in the this situation:.escapeHtml: Escape HTML code to stop it from being rendered as HTML.registerComponent: Register an element to be used in the demo block. This is useful for registering parts that are actually imported coming from various other reports.See instance over in the Trial Blocks area.markdownCss.Type: chain.File course to a stylesheet to utilize for the Markdown page. This will definitely be incorporated using so it is going to simply put on the fall web page. Practical for styling only the HTML generated by the MarkdownIt plugin.useVOnce.Kind: boolean.Whether to include v-once to the entire Accounting allowance web page. This are going to stop the Markdown web page from being re-rendered when the Vue part is upgraded.Warning: This will certainly turn off trial blocks. Only utilize this if you have a sizable documentation and also do not need trial blocks.Connected.unplugin-vue-markdown.Another Vite plugin for organizing Markdown data to Vue elements.This plugin has drawn inspiration coming from it but possesses a different function set. This plugin just sustains Vue.js code in code blocks.Github.Scenery Github.