.This Vite plugin adds assistance for importing a Fall documents as a Vue component. Functions with Vue 2 & 3.Vue.js Demo Blocks.Render your Vue.js code blocks out inline through just incorporating trial close to the language name.As an example, when this Markdown data is left through this plugin, you'll observe a clickable button right here:."' vue trial.
Click me."'( end).Put up.npm install -D vite-vue-md.Setup.In your vite.config.js documents:.Import vite-vue-md and add it to the plugins selection.In your vue() plugin alternatives, add an include choice that includes.md files.vite.config.js:.import vue coming from '@vitejs/ plugin-vue'.+ bring in vueMd from 'vite-vue-md'.export default plugins: [// ...vue( + feature: [/. vue$/,/ . md$/]// u2190 Handle MD documents as Vue elements. ),.+ vueMd(/ * Options */)// u2190 Organize MD files to Vue parts.]// ...To collect a Vue.js codeblock as a Trial Block, include demo beside the foreign language name:."' vue trial.
Click me."'( end).Multi-file demos.The entry purpose for demonstration blocks have to be a Vue.js component. However you may import other code blocks in any kind of language coming from the same Fall report.For non-entry data, set a file name using demo=. Then bring in it from the Vue.js demo block via the doctor: protocol:.
Click me.
2nd file:.trial= click-handler. js.export const clickHandler = () => alert(' Clicked on!').Demonstration + Code obstructs.Since the code blocks are actually delivered inline, they are actually replaced due to the genuine Vue.js element. To reveal the code block, you can easily incorporate a onDemo callback to the plugin choices:.( onDemo( componentTag, code) // Sign up the wrapper part.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Return a custom-made HTML string.return '.$ componentTag
$ this.escapeHtml( code)'. ).Options.consist of.Kind: ReadonlyArray|chain|RegExp.Documents to include coming from being actually put together as Vue documents.leave out.Type: ReadonlyArray|chain|RegExp.Data to exclude coming from being collected as Vue files.markdownItOptions.Style: markdownIt.Options.MarkdownIt choices. Check out MarkdownIt's documents to find out more.markdownItSetup.Kind: (md: markdownIt) => space.Callback to incorporate plugins to MarkdownIt.wrapperClass.Style: cord.Default: markdown-body.The training class to contribute to the cover component which contains the Markdown webpage.onDemo.Kind:.(.tag: strand,.code: cord,.trials: Chart.) => cord.You may obstruct each trial block and also return a customized HTML cord. This is useful for adding custom-made designing to trial blocks.Furthermore, there are actually utils left open in the this context:.escapeHtml: Breaking away HTML code to prevent it coming from being actually rendered as HTML.registerComponent: Register a component to be utilized in the demonstration block. This works for enrolling elements that are imported coming from various other data.View instance above in the Demo Blocks area.markdownCss.Type: string.Submit pathway to a stylesheet to utilize for the Fall webpage. This will definitely be actually added making use of so it will just put on the accounting allowance webpage. Beneficial for styling only the HTML generated by the MarkdownIt plugin.useVOnce.Kind: boolean.Whether to include v-once to the whole entire Markdown webpage. This will certainly avoid the Markdown webpage coming from being re-rendered when the Vue element is improved.Caution: This will definitely turn off demonstration blocks. Just use this if you possess a huge documentation and also don't need demo blocks.Connected.unplugin-vue-markdown.One more Vite plugin for collecting Markdown files to Vue parts.This plugin has actually attracted inspiration from it but has a various feature set. This plugin just supports Vue.js code in code blocks.Github.Sight Github.