.This Vite plugin incorporates support for importing a Fall data as a Vue part. Functions with Vue 2 & 3.Vue.js Demonstration Blocks.Provide your Vue.js code blocks out inline by just incorporating trial beside the language title.For example, when this Markdown file is actually provided with this plugin, you'll find a clickable button below:."' vue demo.
Click me."'( end).Put up.npm set up -D vite-vue-md.Create.In your vite.config.js file:.Import vite-vue-md as well as include it to the plugins variety.In your vue() plugin choices, add a consist of choice that includes.md data.vite.config.js:.bring in vue from '@vitejs/ plugin-vue'.+ import vueMd coming from 'vite-vue-md'.export default plugins: [// ...vue( + include: [/. vue$/,/ . md$/]// u2190 Alleviate MD data as Vue elements. ),.+ vueMd(/ * Options */)// u2190 Collect MD data to Vue elements.]// ...To collect a Vue.js codeblock as a Trial Block, add trial alongside the language title:."' vue demo.
Click me."'( end).Multi-file demos.The entry purpose for demonstration blocks need to be actually a Vue.js element. But you can import various other code blocks out in any foreign language coming from the same Markdown report.For non-entry data, set a report label through demo=. After that import it from the Vue.js demo block by means of the doc: protocol:.
Click me.
Second documents:.demo= click-handler. js.export const clickHandler = () => sharp(' Clicked on!').Demo + Code obstructs.Given that the code blocks are actually rendered inline, they're changed due to the real Vue.js part. To show the code block, you can easily incorporate a onDemo callback to the plugin choices:.( onDemo( componentTag, code) // Sign up the cover component.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Profits a personalized HTML strand.profit '.$ componentTag
$ this.escapeHtml( code)'. ).Options.feature.Kind: ReadonlyArray|chain|RegExp.Documents to feature from being actually assembled as Vue data.omit.Kind: ReadonlyArray|string|RegExp.Reports to exclude coming from being organized as Vue data.markdownItOptions.Kind: markdownIt.Options.MarkdownIt choices. Go to MarkdownIt's documents to read more.markdownItSetup.Style: (md: markdownIt) => void.Callback to incorporate plugins to MarkdownIt.wrapperClass.Type: strand.Default: markdown-body.The course to include in the wrapper element that contains the Fall page.onDemo.Kind:.(.tag: string,.code: cord,.demos: Chart.) => string.You may intercept each trial block and also come back a custom-made HTML cord. This works for adding custom styling to demonstration blocks.In addition, there are utils subjected in the this circumstance:.escapeHtml: Escape HTML code to avoid it coming from being rendered as HTML.registerComponent: Sign up an element to be used in the demo block. This is useful for registering components that are imported from other documents.See example above in the Trial Blocks section.markdownCss.Style: string.File course to a stylesheet to make use of for the Fall web page. This will certainly be added utilizing so it is going to merely relate to the markdown page. Practical for designating just the HTML generated by the MarkdownIt plugin.useVOnce.Type: boolean.Whether to incorporate v-once to the entire Accounting allowance web page. This will definitely protect against the Fall web page from being actually re-rendered when the Vue component is actually upgraded.Warning: This will definitely disable trial blocks. Simply use this if you have a large documentation as well as don't need demo blocks.Connected.unplugin-vue-markdown.One more Vite plugin for organizing Fall reports to Vue elements.This plugin has actually attracted inspiration coming from it but possesses a various feature collection. This plugin only sustains Vue.js code in code blocks.Github.Perspective Github.