.This Vite plugin incorporates assistance for importing a Fall file as a Vue part. Functions along with Vue 2 & 3.Vue.js Trial Blocks.Provide your Vue.js code shuts out inline by simply incorporating demonstration alongside the foreign language name.For example, when this Markdown documents is actually left through this plugin, you'll find a clickable button below:."' vue trial.
Click me."'( end).Install.npm put up -D vite-vue-md.Setup.In your vite.config.js report:.Bring in vite-vue-md and add it to the plugins array.In your vue() plugin alternatives, incorporate a consist of option that includes.md data.vite.config.js:.bring in vue from '@vitejs/ plugin-vue'.+ import vueMd coming from 'vite-vue-md'.export nonpayment plugins: [// ...vue( + consist of: [/. vue$/,/ . md$/]// u2190 Deal with MD reports as Vue parts. ),.+ vueMd(/ * Options */)// u2190 Assemble MD files to Vue components.]// ...To collect a Vue.js codeblock as a Trial Block, add demonstration beside the language label:."' vue trial.
Click me."'( end).Multi-file demos.The access purpose for demonstration blocks should be a Vue.js part. However you can import various other code obstructs in any kind of foreign language coming from the very same Markdown data.For non-entry documents, set a documents title using trial=. Then bring in it from the Vue.js trial block via the doctor: protocol:.
Click me.
Second documents:.demonstration= click-handler. js.export const clickHandler = () => sharp(' Clicked on!').Trial + Code obstructs.Considering that the code blocks are delivered inline, they're switched out due to the actual Vue.js part. To show the code block, you can incorporate a onDemo callback to the plugin alternatives:.( onDemo( componentTag, code) // Sign up the cover component.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Profits a personalized HTML strand.return '.$ componentTag
$ this.escapeHtml( code)'. ).Choices.feature.Type: ReadonlyArray|chain|RegExp.Data to consist of from being actually collected as Vue reports.omit.Kind: ReadonlyArray|string|RegExp.Documents to exclude coming from being compiled as Vue files.markdownItOptions.Kind: markdownIt.Options.MarkdownIt possibilities. See MarkdownIt's documentation for more details.markdownItSetup.Type: (md: markdownIt) => space.Callback to incorporate plugins to MarkdownIt.wrapperClass.Kind: strand.Default: markdown-body.The class to add to the wrapper factor which contains the Markdown web page.onDemo.Type:.(.tag: cord,.code: strand,.trials: Map.) => string.You may intercept each trial block and come back a personalized HTML strand. This works for adding personalized designing to demo blocks.Moreover, there are utils subjected in the this context:.escapeHtml: Retreat HTML code to avoid it from being actually left as HTML.registerComponent: Register a part to be utilized in the demonstration block. This works for registering elements that are actually imported from various other data.Observe instance above in the Trial Blocks section.markdownCss.Style: string.Submit pathway to a stylesheet to utilize for the Markdown web page. This will certainly be actually incorporated utilizing so it is going to only relate to the markdown page. Useful for styling merely the HTML produced due to the MarkdownIt plugin.useVOnce.Type: boolean.Whether to incorporate v-once to the entire Accounting allowance page. This will certainly stop the Fall page from being actually re-rendered when the Vue component is upgraded.Precaution: This are going to turn off demonstration blocks. Just use this if you possess a huge record and do not need trial blocks.Related.unplugin-vue-markdown.Another Vite plugin for putting together Markdown files to Vue components.This plugin has drawn motivation from it yet has a different function collection. This plugin only supports Vue.js code in code blocks.Github.Sight Github.