.This Vite plugin incorporates assistance for importing a Markdown report as a Vue part. Functions with Vue 2 & 3.Vue.js Trial Blocks.Make your Vue.js code shuts out inline through just including demo next to the foreign language title.As an example, when this Fall file is actually made through this plugin, you'll observe a clickable button here:."' vue trial.
Click me."'( end).Put up.npm put in -D vite-vue-md.Create.In your vite.config.js file:.Import vite-vue-md and also incorporate it to the plugins array.In your vue() plugin alternatives, add a feature possibility that includes.md documents.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 Treat MD reports as Vue parts. ),.+ vueMd(/ * Options */)// u2190 Assemble MD reports to Vue elements.]// ...To assemble a Vue.js codeblock as a Demonstration Block, include demonstration beside the language name:."' vue demonstration.
Click me."'( end).Multi-file demonstrations.The entry purpose for demonstration blocks must be a Vue.js element. However you may import other code obstructs in any sort of foreign language coming from the exact same Markdown data.For non-entry documents, set a report title through trial=. Then bring in it from the Vue.js trial block via the doc: procedure:.
Click me.
2nd data:.demo= click-handler. js.export const clickHandler = () => alert(' Clicked on!').Trial + Code blocks out.Due to the fact that the code blocks are delivered inline, they're changed due to the real Vue.js part. To present the code block, you can easily include a onDemo callback to the plugin alternatives:.( onDemo( componentTag, code) // Sign up the cover element.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Return a custom HTML strand.yield '.$ componentTag
$ this.escapeHtml( code)'. ).Alternatives.consist of.Type: ReadonlyArray|string|RegExp.Files to include from being actually put together as Vue data.omit.Kind: ReadonlyArray|string|RegExp.Data to exclude from being compiled as Vue data.markdownItOptions.Style: markdownIt.Options.MarkdownIt possibilities. Check out MarkdownIt's information to read more.markdownItSetup.Type: (md: markdownIt) => void.Callback to include plugins to MarkdownIt.wrapperClass.Type: string.Nonpayment: markdown-body.The course to include in the wrapper element which contains the Fall page.onDemo.Style:.(.tag: string,.code: strand,.demos: Map.) => string.You may obstruct each trial block as well as return a custom HTML cord. This works for adding customized styling to demo blocks.Moreover, there are utils exposed in the this circumstance:.escapeHtml: Retreat HTML code to avoid it coming from being made as HTML.registerComponent: Sign up an element to become utilized in the demo block. This is useful for signing up components that are actually imported from various other documents.See instance over in the Demo Blocks part.markdownCss.Type: chain.File pathway to a stylesheet to make use of for the Markdown webpage. This will definitely be actually incorporated making use of so it will only relate to the markdown web page. Beneficial for designating merely the HTML created by the MarkdownIt plugin.useVOnce.Style: boolean.Whether to incorporate v-once to the entire Markdown page. This will definitely prevent the Fall web page from being actually re-rendered when the Vue component is actually updated.Precaution: This will definitely disable demonstration blocks. Only utilize this if you possess a big documentation and do not need demo blocks.Related.unplugin-vue-markdown.An additional Vite plugin for putting together Fall documents to Vue components.This plugin has actually drawn ideas coming from it however possesses a different attribute set. This plugin simply supports Vue.js code in code blocks.Github.Scenery Github.