.This Vite plugin incorporates help for importing a Markdown data as a Vue element. Performs with Vue 2 & 3.Vue.js Demo Blocks.Leave your Vue.js code obstructs inline by just including trial alongside the language name.For example, when this Fall documents is provided through this plugin, you'll observe a clickable button listed below:."' vue trial.
Click me."'( end).Mount.npm put in -D vite-vue-md.Create.In your vite.config.js documents:.Import vite-vue-md as well as incorporate it to the plugins array.In your vue() plugin options, add an include alternative that includes.md reports.vite.config.js:.bring in vue from '@vitejs/ plugin-vue'.+ import vueMd coming from 'vite-vue-md'.export nonpayment plugins: [// ...vue( + feature: [/. vue$/,/ . md$/]// u2190 Handle MD documents as Vue parts. ),.+ vueMd(/ * Options */)// u2190 Compile MD data to Vue elements.]// ...To put together a Vue.js codeblock as a Demo Block, include trial close to the language title:."' vue demonstration.
Click me."'( end).Multi-file demonstrations.The access point for demonstration blocks should be actually a Vue.js part. However you can easily import other code shuts out in any sort of language from the very same Markdown report.For non-entry documents, put a file title using demo=. Then import it coming from the Vue.js demonstration block using the doc: process:.
Click me.
Second documents:.demo= click-handler. js.export const clickHandler = () => sharp(' Clicked!').Demonstration + Code shuts out.Considering that the code blocks are provided inline, they are actually replaced due to the real Vue.js component. To show the code block, you can incorporate a onDemo callback to the plugin options:.( onDemo( componentTag, code) // Register the cover part.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Come back a custom HTML strand.gain '.$ componentTag
$ this.escapeHtml( code)'. ).Options.consist of.Style: ReadonlyArray|chain|RegExp.Files to include coming from being actually put together as Vue files.leave out.Style: ReadonlyArray|string|RegExp.Files to omit coming from being put together as Vue documents.markdownItOptions.Kind: markdownIt.Options.MarkdownIt alternatives. Visit MarkdownIt's documents to learn more.markdownItSetup.Kind: (md: markdownIt) => gap.Callback to incorporate plugins to MarkdownIt.wrapperClass.Style: cord.Nonpayment: markdown-body.The class to contribute to the wrapper component that contains the Fall web page.onDemo.Style:.(.tag: cord,.code: strand,.demos: Map.) => strand.You may obstruct each trial block as well as return a customized HTML strand. This serves for incorporating customized styling to trial blocks.In addition, there are actually utils subjected in the this situation:.escapeHtml: Escape HTML code to stop it coming from being actually made as HTML.registerComponent: Sign up a component to be used in the demonstration block. This serves for registering parts that are imported coming from other files.Find example above in the Demo Blocks segment.markdownCss.Type: string.File road to a stylesheet to make use of for the Accounting allowance webpage. This will definitely be actually included making use of so it is going to simply apply to the markdown page. Useful for designating simply the HTML generated by the MarkdownIt plugin.useVOnce.Kind: boolean.Whether to add v-once to the whole entire Accounting allowance web page. This will protect against the Fall webpage coming from being actually re-rendered when the Vue component is actually upgraded.Warning: This will certainly disable demonstration blocks. Only use this if you have a huge documentation and do not need demonstration blocks.Associated.unplugin-vue-markdown.One more Vite plugin for assembling Fall data to Vue parts.This plugin has actually attracted ideas coming from it however has a different attribute collection. This plugin simply sustains Vue.js code in code blocks.Github.Perspective Github.