.This Vite plugin incorporates assistance for importing a Markdown report as a Vue element. Functions along with Vue 2 & 3.Vue.js Trial Blocks.Render your Vue.js code blocks inline through merely adding demo next to the language title.As an example, when this Markdown documents is actually left through this plugin, you'll see a clickable switch here:."' vue demonstration.
Click me."'( end).Set up.npm put up -D vite-vue-md.Create.In your vite.config.js data:.Import vite-vue-md and also add it to the plugins assortment.In your vue() plugin options, incorporate an include alternative that includes.md data.vite.config.js:.import vue coming from '@vitejs/ plugin-vue'.+ bring in vueMd from 'vite-vue-md'.export default plugins: [// ...vue( + consist of: [/. vue$/,/ . md$/]// u2190 Treat MD files as Vue components. ),.+ vueMd(/ * Options */)// u2190 Collect MD files to Vue parts.]// ...To collect a Vue.js codeblock as a Demo Block, include demonstration beside the foreign language title:."' vue demo.
Click me."'( end).Multi-file demonstrations.The admittance aim for trial blocks need to be a Vue.js part. Yet you can import various other code blocks in any foreign language coming from the very same Accounting allowance report.For non-entry files, placed a report title via trial=. At that point bring in it from the Vue.js demonstration block through the doc: process:.
Click me.
2nd documents:.demo= click-handler. js.export const clickHandler = () => alert(' Clicked on!').Demo + Code shuts out.Considering that the code blocks are actually made inline, they're replaced due to the real Vue.js component. To reveal the code block, you can easily incorporate a onDemo callback to the plugin options:.( onDemo( componentTag, code) // Register the wrapper part.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Profits a personalized HTML string.gain '.$ componentTag
$ this.escapeHtml( code)'. ).Options.include.Kind: ReadonlyArray|string|RegExp.Files to feature coming from being organized as Vue data.omit.Kind: ReadonlyArray|string|RegExp.Files to exclude from being assembled as Vue reports.markdownItOptions.Type: markdownIt.Options.MarkdownIt choices. Visit MarkdownIt's paperwork to find out more.markdownItSetup.Type: (md: markdownIt) => gap.Callback to include plugins to MarkdownIt.wrapperClass.Kind: strand.Nonpayment: markdown-body.The training class to add to the cover component that contains the Markdown webpage.onDemo.Style:.(.tag: cord,.code: cord,.demos: Chart.) => strand.You may obstruct each demonstration block and also come back a customized HTML strand. This works for including custom styling to trial blocks.Additionally, there are actually utils left open in the this context:.escapeHtml: Breaking away HTML code to prevent it from being actually left as HTML.registerComponent: Register a component to be used in the trial block. This serves for registering components that are imported coming from various other documents.Find example above in the Demo Blocks part.markdownCss.Kind: chain.Submit path to a stylesheet to use for the Fall page. This will certainly be added utilizing so it will just put on the fall webpage. Helpful for styling just the HTML generated by the MarkdownIt plugin.useVOnce.Kind: boolean.Whether to add v-once to the entire Markdown web page. This will certainly avoid the Markdown page from being re-rendered when the Vue element is actually upgraded.Warning: This will definitely disable demo blocks. Just utilize this if you have a large file and don't need to have trial blocks.Related.unplugin-vue-markdown.One more Vite plugin for putting together Fall documents to Vue components.This plugin has actually attracted ideas from it yet has a various attribute set. This plugin only assists Vue.js code in code blocks.Github.View Github.