.This Vite plugin includes assistance for importing a Markdown file as a Vue part. Functions along with Vue 2 & 3.Vue.js Demo Blocks.Leave your Vue.js code blocks out inline through just incorporating trial close to the foreign language name.For example, when this Fall file is actually made through this plugin, you'll see a clickable button right here:."' vue trial.
Click me."'( end).Install.npm set up -D vite-vue-md.Setup.In your vite.config.js data:.Bring in vite-vue-md and incorporate it to the plugins variety.In your vue() plugin possibilities, add a consist of choice that includes.md documents.vite.config.js:.bring in vue coming from '@vitejs/ plugin-vue'.+ import vueMd from 'vite-vue-md'.export nonpayment plugins: [// ...vue( + consist of: [/. vue$/,/ . md$/]// u2190 Alleviate MD data as Vue parts. ),.+ vueMd(/ * Options */)// u2190 Collect MD data to Vue parts.]// ...To compile a Vue.js codeblock as a Demonstration Block, include trial beside the foreign language title:."' vue demo.
Click me."'( end).Multi-file demos.The access purpose for demonstration blocks should be a Vue.js component. However you can import various other code obstructs in any kind of language coming from the very same Fall documents.For non-entry data, set a file name through demo=. Then bring in it from the Vue.js demonstration block through the doc: procedure:.
Click me.
Second data:.demo= click-handler. js.export const clickHandler = () => alert(' Clicked!').Demo + Code shuts out.Due to the fact that the code blocks are actually rendered inline, they're substituted due to the actual Vue.js part. To reveal the code block, you can add a onDemo callback to the plugin choices:.( onDemo( componentTag, code) // Register the cover part.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Come back a customized HTML strand.profit '.$ componentTag
$ this.escapeHtml( code)'. ).Choices.feature.Style: ReadonlyArray|string|RegExp.Reports to consist of coming from being actually compiled as Vue files.leave out.Kind: ReadonlyArray|chain|RegExp.Documents to exclude coming from being actually compiled as Vue files.markdownItOptions.Style: markdownIt.Options.MarkdownIt options. Go to MarkdownIt's documents for more information.markdownItSetup.Style: (md: markdownIt) => space.Callback to add plugins to MarkdownIt.wrapperClass.Kind: cord.Nonpayment: markdown-body.The course to contribute to the cover element that contains the Fall page.onDemo.Style:.(.tag: cord,.code: string,.trials: Chart.) => string.You may obstruct each demonstration block as well as return a custom HTML strand. This works for adding custom styling to trial blocks.Additionally, there are utils subjected in the this context:.escapeHtml: Escape HTML code to stop it from being actually rendered as HTML.registerComponent: Register a component to become used in the demo block. This works for registering elements that are imported coming from various other files.Observe example over in the Demo Blocks part.markdownCss.Style: chain.Submit path to a stylesheet to use for the Markdown page. This will be actually added utilizing so it will just apply to the markdown web page. Valuable for styling just the HTML produced by the MarkdownIt plugin.useVOnce.Kind: boolean.Whether to include v-once to the entire Fall webpage. This will avoid the Fall web page from being re-rendered when the Vue element is improved.Warning: This will definitely turn off demo blocks. Merely use this if you possess a big documentation and do not require demo blocks.Related.unplugin-vue-markdown.Another Vite plugin for assembling Accounting allowance files to Vue elements.This plugin has drawn inspiration from it however possesses a various attribute collection. This plugin merely sustains Vue.js code in code blocks.Github.View Github.