.This Vite plugin adds help for importing a Markdown documents as a Vue component. Performs along with Vue 2 & 3.Vue.js Demo Blocks.Provide your Vue.js code blocks inline by simply including trial alongside the language name.For instance, when this Fall data is left using this plugin, you'll observe a clickable button here:."' vue demo.
Click me."'( end).Set up.npm set up -D vite-vue-md.Create.In your vite.config.js file:.Import vite-vue-md and include it to the plugins assortment.In your vue() plugin options, include a feature option that includes.md data.vite.config.js:.bring in vue from '@vitejs/ plugin-vue'.+ bring in vueMd from 'vite-vue-md'.export default plugins: [// ...vue( + consist of: [/. vue$/,/ . md$/]// u2190 Manage MD reports as Vue elements. ),.+ vueMd(/ * Options */)// u2190 Assemble MD reports to Vue parts.]// ...To assemble a Vue.js codeblock as a Demo Block, incorporate demo next to the language label:."' vue trial.
Click me."'( end).Multi-file demonstrations.The entry goal for trial blocks need to be a Vue.js element. Yet you may import other code shuts out in any sort of language coming from the exact same Accounting allowance report.For non-entry documents, set a file label using demonstration=. After that import it from the Vue.js demo block by means of the doc: procedure:.
Click me.
2nd report:.demo= click-handler. js.export const clickHandler = () => sharp(' Clicked on!').Demonstration + Code shuts out.Due to the fact that the code blocks are actually delivered inline, they are actually changed due to the genuine Vue.js part. To present the code block, you can include a onDemo callback to the plugin alternatives:.( onDemo( componentTag, code) // Sign up the cover component.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Profits a personalized HTML string.return '.$ componentTag
$ this.escapeHtml( code)'. ).Options.include.Style: ReadonlyArray|chain|RegExp.Files to feature from being actually put together as Vue reports.leave out.Kind: ReadonlyArray|chain|RegExp.Documents to leave out from being organized as Vue documents.markdownItOptions.Type: markdownIt.Options.MarkdownIt choices. Check out MarkdownIt's information to find out more.markdownItSetup.Style: (md: markdownIt) => space.Callback to add plugins to MarkdownIt.wrapperClass.Kind: strand.Default: markdown-body.The lesson to add to the cover aspect which contains the Markdown webpage.onDemo.Style:.(.tag: string,.code: cord,.demonstrations: Chart.) => string.You can intercept each demonstration block as well as return a custom HTML strand. This works for incorporating custom designing to demo blocks.Additionally, there are utils left open in the this circumstance:.escapeHtml: Getaway HTML code to avoid it coming from being actually left as HTML.registerComponent: Register an element to be used in the trial block. This is useful for enrolling parts that are actually imported coming from various other data.See example over in the Demo Blocks part.markdownCss.Style: string.Submit course to a stylesheet to use for the Fall webpage. This are going to be actually incorporated utilizing so it will just relate to the fall webpage. Practical for designating simply the HTML created due to the MarkdownIt plugin.useVOnce.Type: boolean.Whether to include v-once to the entire Markdown page. This will certainly prevent the Fall webpage coming from being actually re-rendered when the Vue component is upgraded.Caution: This are going to disable demonstration blocks. Simply use this if you have a huge document and don't need to have demonstration blocks.Connected.unplugin-vue-markdown.Another Vite plugin for compiling Fall files to Vue parts.This plugin has actually attracted inspiration from it yet possesses a different attribute collection. This plugin simply supports Vue.js code in code blocks.Github.Perspective Github.