.This Vite plugin incorporates assistance for importing a Markdown documents as a Vue element. Works with Vue 2 & 3.Vue.js Demo Blocks.Render your Vue.js code obstructs inline by simply adding demo beside the language name.For example, when this Fall documents is actually left with this plugin, you'll find a clickable button here:."' vue trial.
Click me."'( end).Mount.npm set up -D vite-vue-md.Setup.In your vite.config.js file:.Import vite-vue-md and also include it to the plugins array.In your vue() plugin options, include a feature option that includes.md documents.vite.config.js:.bring in vue from '@vitejs/ plugin-vue'.+ bring in vueMd from 'vite-vue-md'.export default plugins: [// ...vue( + feature: [/. vue$/,/ . md$/]// u2190 Treat MD data as Vue components. ),.+ vueMd(/ * Options */)// u2190 Collect MD data to Vue components.]// ...To organize a Vue.js codeblock as a Demo Block, add demonstration next to the language title:."' vue demo.
Click me."'( end).Multi-file demos.The admittance purpose for trial blocks have to be a Vue.js component. However you may import various other code obstructs in any sort of foreign language coming from the exact same Markdown documents.For non-entry reports, established a file title via demo=. Then import it coming from the Vue.js demo block via the doc: protocol:.
Click me.
2nd report:.trial= click-handler. js.export const clickHandler = () => sharp(' Clicked!').Trial + Code obstructs.Due to the fact that the code blocks are actually made inline, they're changed by the genuine Vue.js component. To reveal the code block, you can easily add a onDemo callback to the plugin alternatives:.( onDemo( componentTag, code) // Sign up the cover part.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Come back a custom HTML string.profit '.$ componentTag
$ this.escapeHtml( code)'. ).Options.include.Type: ReadonlyArray|chain|RegExp.Files to consist of from being collected as Vue documents.leave out.Type: ReadonlyArray|chain|RegExp.Documents to leave out coming from being actually compiled as Vue documents.markdownItOptions.Style: markdownIt.Options.MarkdownIt possibilities. Visit MarkdownIt's records for additional information.markdownItSetup.Type: (md: markdownIt) => void.Callback to add plugins to MarkdownIt.wrapperClass.Kind: string.Default: markdown-body.The course to contribute to the wrapper factor that contains the Fall webpage.onDemo.Type:.(.tag: cord,.code: strand,.demonstrations: Chart.) => strand.You can easily obstruct each demo block and also come back a personalized HTML string. This works for including custom-made styling to demo blocks.In addition, there are actually utils exposed in the this circumstance:.escapeHtml: Retreat HTML code to stop it from being actually rendered as HTML.registerComponent: Sign up a component to become utilized in the trial block. This is useful for enrolling components that are actually imported coming from other reports.See example above in the Trial Blocks section.markdownCss.Type: string.Submit road to a stylesheet to utilize for the Fall webpage. This will definitely be included utilizing so it is going to only put on the accounting allowance webpage. Useful for styling just the HTML generated by the MarkdownIt plugin.useVOnce.Kind: boolean.Whether to include v-once to the entire Markdown web page. This will certainly stop the Accounting allowance webpage coming from being re-rendered when the Vue component is upgraded.Precaution: This are going to disable demo blocks. Just use this if you possess a huge file and don't require demo blocks.Related.unplugin-vue-markdown.Yet another Vite plugin for collecting Markdown reports to Vue components.This plugin has actually drawn ideas from it however possesses a various feature set. This plugin merely sustains Vue.js code in code blocks.Github.Scenery Github.