.This Vite plugin incorporates support for importing a Markdown file as a Vue part. Performs along with Vue 2 & 3.Vue.js Trial Blocks.Make your Vue.js code blocks inline by merely incorporating demo close to the language label.As an example, when this Accounting allowance data is actually rendered through this plugin, you'll observe a clickable button listed below:."' vue demonstration.
Click me."'( end).Put up.npm mount -D vite-vue-md.Setup.In your vite.config.js report:.Bring in vite-vue-md as well as add it to the plugins selection.In your vue() plugin possibilities, include a consist of possibility that includes.md reports.vite.config.js:.bring in vue from '@vitejs/ plugin-vue'.+ bring in vueMd coming from 'vite-vue-md'.export default plugins: [// ...vue( + include: [/. vue$/,/ . md$/]// u2190 Manage MD reports as Vue parts. ),.+ vueMd(/ * Options */)// u2190 Collect MD data to Vue elements.]// ...To put together a Vue.js codeblock as a Demo Block, incorporate demonstration next to the language title:."' vue demonstration.
Click me."'( end).Multi-file demos.The access aim for trial blocks have to be a Vue.js component. However you can easily import various other code shuts out in any type of foreign language coming from the exact same Markdown report.For non-entry documents, placed a documents name via demonstration=. After that bring in it from the Vue.js demo block using the doctor: process:.
Click me.
2nd report:.demonstration= click-handler. js.export const clickHandler = () => sharp(' Clicked!').Demonstration + Code obstructs.Due to the fact that the code blocks are actually rendered inline, they are actually switched out by the actual Vue.js part. To reveal the code block, you can easily add a onDemo callback to the plugin choices:.( onDemo( componentTag, code) // Sign up the wrapper component.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Profits a custom HTML string.yield '.$ componentTag
$ this.escapeHtml( code)'. ).Alternatives.consist of.Kind: ReadonlyArray|chain|RegExp.Data to consist of coming from being collected as Vue documents.exclude.Style: ReadonlyArray|chain|RegExp.Documents to omit coming from being put together as Vue documents.markdownItOptions.Type: markdownIt.Options.MarkdownIt alternatives. Go to MarkdownIt's information for more details.markdownItSetup.Type: (md: markdownIt) => void.Callback to add plugins to MarkdownIt.wrapperClass.Type: cord.Default: markdown-body.The course to add to the cover factor that contains the Markdown page.onDemo.Kind:.(.tag: cord,.code: strand,.trials: Map.) => cord.You can easily obstruct each demonstration block and also return a customized HTML string. This is useful for incorporating custom-made styling to demo blocks.Furthermore, there are utils revealed in the this circumstance:.escapeHtml: Breaking away HTML code to prevent it from being rendered as HTML.registerComponent: Sign up a part to become utilized in the demo block. This is useful for registering elements that are actually imported from other files.Find instance over in the Demonstration Blocks section.markdownCss.Kind: string.File road to a stylesheet to utilize for the Markdown page. This will certainly be included using so it is going to simply apply to the fall web page. Helpful for styling merely the HTML produced by the MarkdownIt plugin.useVOnce.Style: boolean.Whether to add v-once to the whole entire Fall web page. This will certainly protect against the Accounting allowance page from being actually re-rendered when the Vue part is actually updated.Precaution: This are going to disable demo blocks. Only use this if you possess a huge file as well as don't need to have trial blocks.Associated.unplugin-vue-markdown.One more Vite plugin for putting together Markdown data to Vue parts.This plugin has actually attracted inspiration from it but possesses a various feature set. This plugin merely assists Vue.js code in code blocks.Github.View Github.