.This Vite plugin includes help for importing a Markdown documents as a Vue component. Functions with Vue 2 & 3.Vue.js Demonstration Blocks.Leave your Vue.js code blocks out inline through simply adding demonstration beside the language label.As an example, when this Fall documents is actually rendered with this plugin, you'll see a clickable switch right here:."' vue demonstration.
Click me."'( end).Install.npm put in -D vite-vue-md.Create.In your vite.config.js file:.Bring in vite-vue-md and incorporate it to the plugins assortment.In your vue() plugin alternatives, incorporate an include alternative that includes.md files.vite.config.js:.bring in vue from '@vitejs/ plugin-vue'.+ bring in vueMd from 'vite-vue-md'.export default plugins: [// ...vue( + include: [/. vue$/,/ . md$/]// u2190 Handle MD data as Vue components. ),.+ vueMd(/ * Options */)// u2190 Organize MD data to Vue components.]// ...To compile a Vue.js codeblock as a Demo Block, include demo alongside the foreign language label:."' vue demonstration.
Click me."'( end).Multi-file trials.The access goal for trial blocks should be actually a Vue.js part. Yet you can easily import other code blocks in any foreign language from the very same Fall file.For non-entry data, put a file name using trial=. After that import it coming from the Vue.js demonstration block through the doc: procedure:.
Click me.
2nd report:.demonstration= click-handler. js.export const clickHandler = () => sharp(' Clicked!').Trial + Code obstructs.Considering that the code blocks are actually made inline, they're substituted due to the real Vue.js element. To show the code block, you can incorporate a onDemo callback to the plugin options:.( onDemo( componentTag, code) // Sign up the cover part.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Profits a custom HTML string.profit '.$ componentTag
$ this.escapeHtml( code)'. ).Choices.consist of.Style: ReadonlyArray|string|RegExp.Files to feature from being actually assembled as Vue reports.leave out.Style: ReadonlyArray|chain|RegExp.Data to omit coming from being actually compiled as Vue files.markdownItOptions.Kind: markdownIt.Options.MarkdownIt alternatives. Visit MarkdownIt's documents to find out more.markdownItSetup.Type: (md: markdownIt) => void.Callback to include plugins to MarkdownIt.wrapperClass.Kind: string.Nonpayment: markdown-body.The course to add to the cover aspect which contains the Accounting allowance page.onDemo.Style:.(.tag: strand,.code: strand,.demonstrations: Map.) => strand.You can obstruct each demo block and also return a personalized HTML strand. This is useful for including customized designing to trial blocks.Furthermore, there are actually utils exposed in the this situation:.escapeHtml: Retreat HTML code to prevent it from being actually rendered as HTML.registerComponent: Register a component to become used in the demo block. This works for signing up parts that are imported from various other files.Find example above in the Demonstration Blocks section.markdownCss.Type: string.File road to a stylesheet to utilize for the Accounting allowance webpage. This will certainly be added utilizing so it is going to just apply to the accounting allowance page. Practical for designating just the HTML generated by the MarkdownIt plugin.useVOnce.Kind: boolean.Whether to add v-once to the whole entire Markdown webpage. This are going to protect against the Markdown page from being re-rendered when the Vue part is improved.Alert: This will disable demo blocks. Only use this if you possess a sizable document as well as do not need to have trial blocks.Associated.unplugin-vue-markdown.An additional Vite plugin for collecting Markdown reports to Vue components.This plugin has actually drawn creativity from it but has a various attribute collection. This plugin simply sustains Vue.js code in code blocks.Github.Viewpoint Github.