.This Vite plugin includes support for importing a Fall report as a Vue part. Performs along with Vue 2 & 3.Vue.js Trial Blocks.Render your Vue.js code shuts out inline through merely adding demonstration alongside the foreign language name.For example, when this Fall data is actually rendered using this plugin, you'll observe a clickable switch below:."' vue demonstration.
Click me."'( end).Install.npm mount -D vite-vue-md.Setup.In your vite.config.js documents:.Import vite-vue-md as well as add it to the plugins array.In your vue() plugin options, add an include alternative that includes.md files.vite.config.js:.import vue coming from '@vitejs/ plugin-vue'.+ import vueMd from 'vite-vue-md'.export default plugins: [// ...vue( + consist of: [/. vue$/,/ . md$/]// u2190 Manage MD files as Vue elements. ),.+ vueMd(/ * Options */)// u2190 Compile MD files to Vue components.]// ...To organize a Vue.js codeblock as a Demo Block, include demo beside the language name:."' vue trial.
Click me."'( end).Multi-file demos.The access point for demonstration blocks have to be a Vue.js part. But you can import other code blocks in any kind of language from the same Markdown documents.For non-entry files, set a report title via demonstration=. Then bring in it from the Vue.js trial block through the doc: process:.
Click me.
Second documents:.demo= click-handler. js.export const clickHandler = () => alert(' Clicked on!').Demonstration + Code blocks.Because the code blocks are provided inline, they're replaced due to the genuine Vue.js element. To show the code block, you can easily include a onDemo callback to the plugin alternatives:.( onDemo( componentTag, code) // Register the wrapper part.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Profits a personalized HTML cord.profit '.$ componentTag
$ this.escapeHtml( code)'. ).Choices.consist of.Type: ReadonlyArray|string|RegExp.Data to include coming from being put together as Vue documents.exclude.Kind: ReadonlyArray|chain|RegExp.Files to leave out from being put together as Vue reports.markdownItOptions.Type: markdownIt.Options.MarkdownIt options. See MarkdownIt's paperwork to learn more.markdownItSetup.Kind: (md: markdownIt) => void.Callback to include plugins to MarkdownIt.wrapperClass.Type: string.Nonpayment: markdown-body.The class to include in the wrapper factor which contains the Markdown page.onDemo.Style:.(.tag: strand,.code: strand,.demos: Map.) => strand.You can easily obstruct each trial block and also come back a personalized HTML strand. This is useful for adding customized styling to demonstration blocks.Moreover, there are actually utils revealed in the this circumstance:.escapeHtml: Escape HTML code to avoid it from being actually made as HTML.registerComponent: Register a component to become utilized in the demo block. This is useful for enrolling components that are actually imported from various other reports.View instance above in the Demo Blocks segment.markdownCss.Type: string.Submit course to a stylesheet to utilize for the Markdown webpage. This will certainly be added using so it is going to only relate to the fall webpage. Useful for designating simply the HTML created by the MarkdownIt plugin.useVOnce.Kind: boolean.Whether to add v-once to the entire Accounting allowance web page. This will protect against the Markdown web page coming from being re-rendered when the Vue component is improved.Precaution: This are going to turn off demonstration blocks. Merely utilize this if you possess a big documentation as well as don't need trial blocks.Related.unplugin-vue-markdown.An additional Vite plugin for organizing Fall files to Vue parts.This plugin has attracted ideas from it but possesses a various attribute collection. This plugin merely assists Vue.js code in code blocks.Github.Perspective Github.