.This Vite plugin includes help for importing a Markdown documents as a Vue element. Performs along with Vue 2 & 3.Vue.js Demo Blocks.Render your Vue.js code blocks out inline by just incorporating trial beside the language title.For example, when this Fall report is left through this plugin, you'll find a clickable button here:."' vue demonstration.
Click me."'( end).Install.npm put up -D vite-vue-md.Setup.In your vite.config.js file:.Bring in vite-vue-md and include it to the plugins range.In your vue() plugin choices, incorporate 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( + feature: [/. vue$/,/ . md$/]// u2190 Handle MD documents as Vue elements. ),.+ vueMd(/ * Options */)// u2190 Put together MD documents to Vue components.]// ...To compile a Vue.js codeblock as a Trial Block, include demo alongside the language name:."' vue trial.
Click me."'( end).Multi-file demos.The access aim for trial blocks need to be a Vue.js component. But you can import various other code obstructs in any sort of foreign language coming from the exact same Accounting allowance file.For non-entry data, established a report title by means of demonstration=. Then import it coming from the Vue.js demonstration block through the doctor: method:.
Click me.
Second documents:.demo= click-handler. js.export const clickHandler = () => sharp(' Clicked!').Demonstration + Code blocks out.Because the code blocks are delivered inline, they are actually switched out due to the real Vue.js part. To reveal the code block, you may incorporate a onDemo callback to the plugin options:.( onDemo( componentTag, code) // Register the cover component.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Come back a custom HTML cord.return '.$ componentTag
$ this.escapeHtml( code)'. ).Choices.consist of.Type: ReadonlyArray|string|RegExp.Files to consist of from being actually put together as Vue documents.omit.Kind: ReadonlyArray|chain|RegExp.Documents to omit from being actually compiled as Vue data.markdownItOptions.Style: markdownIt.Options.MarkdownIt choices. Visit MarkdownIt's documents to learn more.markdownItSetup.Style: (md: markdownIt) => void.Callback to include plugins to MarkdownIt.wrapperClass.Style: cord.Nonpayment: markdown-body.The training class to include in the wrapper element which contains the Fall web page.onDemo.Style:.(.tag: string,.code: strand,.demonstrations: Chart.) => cord.You can intercept each demo block as well as come back a custom HTML string. This is useful for adding custom-made designing to trial blocks.Additionally, there are actually utils left open in the this context:.escapeHtml: Breaking away HTML code to avoid it from being rendered as HTML.registerComponent: Register an element to become used in the demonstration block. This serves for registering parts that are actually imported coming from various other files.View example over in the Demonstration Blocks area.markdownCss.Kind: string.File course to a stylesheet to utilize for the Accounting allowance web page. This will be included utilizing so it will merely relate to the markdown page. Beneficial for styling just the HTML generated by the MarkdownIt plugin.useVOnce.Style: boolean.Whether to add v-once to the whole Markdown page. This will definitely avoid the Fall web page from being actually re-rendered when the Vue element is upgraded.Precaution: This are going to disable trial blocks. Just utilize this if you possess a big file as well as don't require trial blocks.Associated.unplugin-vue-markdown.An additional Vite plugin for organizing Fall reports to Vue components.This plugin has actually attracted inspiration coming from it but possesses a various component collection. This plugin only assists Vue.js code in code blocks.Github.Sight Github.