.This Vite plugin incorporates help for importing a Markdown report as a Vue component. Performs with Vue 2 & 3.Vue.js Demo Blocks.Make your Vue.js code blocks out inline by just adding demo alongside the language title.For example, when this Markdown file is actually made using this plugin, you'll observe a clickable button listed below:."' vue demonstration.
Click me."'( end).Put in.npm put in -D vite-vue-md.Setup.In your vite.config.js documents:.Import vite-vue-md and add it to the plugins array.In your vue() plugin options, include an include choice that includes.md reports.vite.config.js:.bring in vue coming from '@vitejs/ plugin-vue'.+ bring in vueMd from 'vite-vue-md'.export default plugins: [// ...vue( + consist of: [/. vue$/,/ . md$/]// u2190 Alleviate MD data as Vue components. ),.+ vueMd(/ * Options */)// u2190 Put together MD documents to Vue parts.]// ...To collect a Vue.js codeblock as a Demonstration Block, incorporate demo next to the language label:."' vue demo.
Click me."'( end).Multi-file trials.The access objective for trial blocks must be actually a Vue.js component. Yet you can easily import other code shuts out in any kind of foreign language from the same Accounting allowance file.For non-entry reports, set a data title by means of demonstration=. Then import it coming from the Vue.js demo block via the doctor: method:.
Click me.
2nd report:.demonstration= click-handler. js.export const clickHandler = () => sharp(' Clicked on!').Trial + Code blocks.Due to the fact that the code blocks are made inline, they're substituted due to the true Vue.js element. To present the code block, you may include a onDemo callback to the plugin options:.( onDemo( componentTag, code) // Sign up the cover part.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Return a custom-made HTML cord.return '.$ componentTag
$ this.escapeHtml( code)'. ).Options.include.Type: ReadonlyArray|chain|RegExp.Data to consist of from being actually organized as Vue data.exclude.Style: ReadonlyArray|string|RegExp.Files to omit from being collected as Vue reports.markdownItOptions.Style: markdownIt.Options.MarkdownIt choices. Check out MarkdownIt's paperwork to find out more.markdownItSetup.Kind: (md: markdownIt) => gap.Callback to include plugins to MarkdownIt.wrapperClass.Kind: strand.Default: markdown-body.The training class to contribute to the cover factor that contains the Fall webpage.onDemo.Style:.(.tag: string,.code: strand,.trials: Chart.) => strand.You can easily obstruct each trial block and return a customized HTML strand. This is useful for incorporating personalized designing to demonstration blocks.Furthermore, there are actually utils subjected in the this situation:.escapeHtml: Getaway HTML code to stop it coming from being actually rendered as HTML.registerComponent: Register an element to become used in the demo block. This works for registering components that are imported coming from other data.Observe instance above in the Demonstration Blocks area.markdownCss.Style: chain.Submit pathway to a stylesheet to make use of for the Markdown webpage. This will be actually included using so it is going to simply put on the markdown webpage. Useful for designating only the HTML created due to the MarkdownIt plugin.useVOnce.Style: boolean.Whether to include v-once to the whole entire Accounting allowance page. This will definitely prevent the Accounting allowance web page coming from being actually re-rendered when the Vue component is actually upgraded.Caution: This will definitely disable demo blocks. Only utilize this if you possess a large record as well as don't require demo blocks.Connected.unplugin-vue-markdown.One more Vite plugin for putting together Fall documents to Vue components.This plugin has pulled inspiration coming from it however has a different attribute collection. This plugin merely sustains Vue.js code in code blocks.Github.View Github.