.This Vite plugin incorporates support for importing a Markdown report as a Vue part. Performs along with Vue 2 & 3.Vue.js Trial Blocks.Leave your Vue.js code blocks inline by simply including demo alongside the foreign language title.For instance, when this Fall file is actually left using this plugin, you'll view a clickable button listed below:."' vue trial.
Click me."'( end).Install.npm install -D vite-vue-md.Setup.In your vite.config.js documents:.Import vite-vue-md as well as add it to the plugins selection.In your vue() plugin possibilities, include an include possibility that includes.md data.vite.config.js:.import vue coming from '@vitejs/ plugin-vue'.+ bring in vueMd coming from 'vite-vue-md'.export default plugins: [// ...vue( + include: [/. vue$/,/ . md$/]// u2190 Manage MD data as Vue components. ),.+ vueMd(/ * Options */)// u2190 Compile MD files to Vue parts.]// ...To organize a Vue.js codeblock as a Demonstration Block, include trial beside the foreign language label:."' vue demonstration.
Click me."'( end).Multi-file trials.The access goal for demo blocks should be a Vue.js element. Yet you can easily import various other code blocks out in any type of language coming from the exact same Accounting allowance report.For non-entry files, put a documents name using demonstration=. At that point bring in it from the Vue.js trial block by means of the doctor: method:.
Click me.
Second data:.demonstration= click-handler. js.export const clickHandler = () => alert(' Clicked!').Demo + Code blocks out.Because the code blocks are delivered inline, they're replaced due to the true Vue.js part. To reveal the code block, you can include a onDemo callback to the plugin alternatives:.( onDemo( componentTag, code) // Register the cover part.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Come back a custom-made HTML string.profit '.$ componentTag
$ this.escapeHtml( code)'. ).Possibilities.feature.Style: ReadonlyArray|chain|RegExp.Files to consist of coming from being collected as Vue files.omit.Type: ReadonlyArray|chain|RegExp.Data to omit from being actually collected as Vue reports.markdownItOptions.Kind: markdownIt.Options.MarkdownIt alternatives. See MarkdownIt's information for more information.markdownItSetup.Style: (md: markdownIt) => gap.Callback to include plugins to MarkdownIt.wrapperClass.Type: strand.Nonpayment: markdown-body.The lesson to add to the wrapper element that contains the Fall webpage.onDemo.Kind:.(.tag: cord,.code: cord,.demos: Map.) => strand.You may obstruct each demo block as well as return a custom HTML cord. This works for incorporating customized designing to demonstration blocks.Furthermore, there are actually utils revealed in the this circumstance:.escapeHtml: Escape HTML code to stop it coming from being left as HTML.registerComponent: Register a part to become used in the trial block. This serves for signing up components that are actually imported coming from other reports.View instance over in the Demo Blocks segment.markdownCss.Style: chain.Submit pathway to a stylesheet to utilize for the Fall webpage. This will be included making use of so it is going to simply put on the fall webpage. Beneficial for styling simply the HTML produced by the MarkdownIt plugin.useVOnce.Style: boolean.Whether to incorporate v-once to the entire Markdown page. This will stop the Fall webpage coming from being re-rendered when the Vue component is actually improved.Caution: This will certainly turn off demonstration blocks. Only use this if you possess a huge file and don't need to have trial blocks.Associated.unplugin-vue-markdown.An additional Vite plugin for assembling Markdown files to Vue elements.This plugin has actually pulled creativity from it however has a different feature set. This plugin merely sustains Vue.js code in code blocks.Github.Sight Github.