.This Vite plugin includes assistance for importing a Markdown file as a Vue part. Works along with Vue 2 & 3.Vue.js Demonstration Blocks.Render your Vue.js code obstructs inline by merely including trial close to the foreign language name.For instance, when this Markdown file is actually made through this plugin, you'll view a clickable button here:."' vue trial.
Click me."'( end).Mount.npm put up -D vite-vue-md.Create.In your vite.config.js data:.Import vite-vue-md and also include it to the plugins collection.In your vue() plugin possibilities, include a feature option that includes.md data.vite.config.js:.import vue from '@vitejs/ plugin-vue'.+ import vueMd from 'vite-vue-md'.export default plugins: [// ...vue( + include: [/. vue$/,/ . md$/]// u2190 Deal with MD data as Vue parts. ),.+ vueMd(/ * Options */)// u2190 Compile MD data to Vue elements.]// ...To organize a Vue.js codeblock as a Trial Block, incorporate demonstration next to the foreign language title:."' vue demonstration.
Click me."'( end).Multi-file demos.The entry point for trial blocks have to be actually a Vue.js component. Yet you may import various other code obstructs in any language from the exact same Accounting allowance report.For non-entry data, placed a report label via demonstration=. After that import it from the Vue.js trial block by means of the doctor: protocol:.
Click me.
Second data:.trial= click-handler. js.export const clickHandler = () => alert(' Clicked on!').Demo + Code blocks.Because the code blocks are delivered inline, they are actually replaced by the genuine Vue.js element. To present the code block, you can add a onDemo callback to the plugin choices:.( onDemo( componentTag, code) // Sign up the cover element.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Come back a custom-made HTML cord.yield '.$ componentTag
$ this.escapeHtml( code)'. ).Options.include.Style: ReadonlyArray|string|RegExp.Reports to consist of from being actually organized as Vue documents.exclude.Style: ReadonlyArray|string|RegExp.Data to leave out coming from being actually compiled as Vue data.markdownItOptions.Type: markdownIt.Options.MarkdownIt alternatives. See MarkdownIt's documentation for more details.markdownItSetup.Style: (md: markdownIt) => space.Callback to add plugins to MarkdownIt.wrapperClass.Kind: cord.Nonpayment: markdown-body.The class to include in the wrapper aspect which contains the Accounting allowance webpage.onDemo.Type:.(.tag: string,.code: cord,.demonstrations: Chart.) => cord.You can obstruct each demo block and come back a customized HTML string. This works for including custom designing to demonstration blocks.On top of that, there are actually utils left open in the this situation:.escapeHtml: Breaking away HTML code to stop it from being left as HTML.registerComponent: Register a component to be made use of in the demo block. This serves for enrolling components that are actually imported from other documents.See instance over in the Trial Blocks area.markdownCss.Type: chain.File pathway to a stylesheet to utilize for the Fall page. This will definitely be actually incorporated utilizing so it will merely put on the markdown page. Valuable for styling just the HTML produced due to the MarkdownIt plugin.useVOnce.Type: boolean.Whether to add v-once to the entire Markdown web page. This will definitely avoid the Fall page coming from being re-rendered when the Vue component is upgraded.Alert: This are going to turn off trial blocks. Just utilize this if you possess a large documentation and also do not require demonstration blocks.Connected.unplugin-vue-markdown.One more Vite plugin for compiling Accounting allowance files to Vue parts.This plugin has attracted motivation coming from it however possesses a various attribute collection. This plugin just sustains Vue.js code in code blocks.Github.Sight Github.