.This Vite plugin adds support for importing a Markdown file as a Vue element. Works with Vue 2 & 3.Vue.js Demo Blocks.Provide your Vue.js code shuts out inline by simply including trial close to the foreign language label.As an example, when this Fall documents is made through this plugin, you'll find a clickable button here:."' vue trial.
Click me."'( end).Put in.npm install -D vite-vue-md.Create.In your vite.config.js file:.Bring in vite-vue-md as well as add it to the plugins collection.In your vue() plugin choices, add an include possibility that includes.md files.vite.config.js:.bring in vue coming from '@vitejs/ plugin-vue'.+ bring in vueMd coming from 'vite-vue-md'.export default plugins: [// ...vue( + consist of: [/. vue$/,/ . md$/]// u2190 Manage MD files as Vue components. ),.+ vueMd(/ * Options */)// u2190 Collect MD reports to Vue parts.]// ...To collect a Vue.js codeblock as a Demo Block, incorporate demo close to the language name:."' vue demo.
Click me."'( end).Multi-file demos.The access aim for demonstration blocks should be a Vue.js element. But you may import other code blocks in any foreign language from the exact same Markdown data.For non-entry documents, put a report label through demo=. Then bring in it from the Vue.js demonstration block via the doctor: procedure:.
Click me.
Second report:.demonstration= click-handler. js.export const clickHandler = () => sharp(' Clicked on!').Trial + Code shuts out.Due to the fact that the code blocks are made inline, they are actually replaced by the true Vue.js component. To reveal the code block, you may add a onDemo callback to the plugin options:.( onDemo( componentTag, code) // Register the cover part.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Return a custom HTML string.gain '.$ componentTag
$ this.escapeHtml( code)'. ).Possibilities.feature.Kind: ReadonlyArray|string|RegExp.Reports to include coming from being actually put together as Vue documents.exclude.Kind: ReadonlyArray|string|RegExp.Files to exclude coming from being actually compiled as Vue reports.markdownItOptions.Type: markdownIt.Options.MarkdownIt alternatives. Go to MarkdownIt's records to learn more.markdownItSetup.Kind: (md: markdownIt) => space.Callback to include plugins to MarkdownIt.wrapperClass.Style: strand.Default: markdown-body.The class to include in the cover element which contains the Markdown webpage.onDemo.Type:.(.tag: cord,.code: cord,.demonstrations: Map.) => cord.You may obstruct each demonstration block as well as return a custom-made HTML cord. This is useful for incorporating custom designing to demonstration blocks.On top of that, there are actually utils left open in the this context:.escapeHtml: Escape HTML code to prevent it coming from being rendered as HTML.registerComponent: Register a component to be used in the demo block. This serves for enrolling components that are imported coming from other data.Observe instance above in the Trial Blocks part.markdownCss.Type: string.File road to a stylesheet to make use of for the Fall webpage. This will certainly be actually added utilizing so it is going to just put on the accounting allowance web page. Valuable for styling only the HTML created by the MarkdownIt plugin.useVOnce.Style: boolean.Whether to include v-once to the whole entire Fall web page. This will protect against the Accounting allowance webpage coming from being re-rendered when the Vue component is improved.Caution: This are going to disable demo blocks. Just use this if you have a sizable file and don't require demo blocks.Related.unplugin-vue-markdown.An additional Vite plugin for collecting Markdown reports to Vue parts.This plugin has pulled motivation from it yet has a different attribute set. This plugin merely supports Vue.js code in code blocks.Github.View Github.