.This Vite plugin adds help for importing a Markdown file as a Vue part. Functions with Vue 2 & 3.Vue.js Demonstration Blocks.Leave your Vue.js code shuts out inline by just including demonstration close to the foreign language label.For instance, when this Accounting allowance report is actually left with this plugin, you'll find a clickable switch here:."' vue trial.
Click me."'( end).Install.npm install -D vite-vue-md.Setup.In your vite.config.js documents:.Import vite-vue-md as well as include it to the plugins selection.In your vue() plugin options, add a feature choice that includes.md data.vite.config.js:.import vue from '@vitejs/ plugin-vue'.+ bring in vueMd from 'vite-vue-md'.export default plugins: [// ...vue( + include: [/. vue$/,/ . md$/]// u2190 Manage MD documents as Vue components. ),.+ vueMd(/ * Options */)// u2190 Organize MD reports to Vue components.]// ...To compile a Vue.js codeblock as a Demo Block, add trial beside the foreign language name:."' vue demonstration.
Click me."'( end).Multi-file demos.The admittance objective for demonstration blocks have to be a Vue.js part. However you may import other code obstructs in any type of foreign language from the exact same Fall file.For non-entry documents, set a file label via trial=. At that point import it from the Vue.js demo block using the doc: procedure:.
Click me.
2nd report:.demo= click-handler. js.export const clickHandler = () => sharp(' Clicked on!').Demo + Code obstructs.Due to the fact that the code blocks are provided inline, they're switched out due to the real Vue.js element. To show the code block, you may incorporate a onDemo callback to the plugin choices:.( onDemo( componentTag, code) // Register the wrapper element.this.registerComponent(' DemoContainer', './ DemoContainer.vue').// Come back a personalized HTML cord.return '.$ componentTag
$ this.escapeHtml( code)'. ).Options.consist of.Type: ReadonlyArray|chain|RegExp.Files to feature coming from being collected as Vue reports.leave out.Type: ReadonlyArray|chain|RegExp.Files to exclude from being actually assembled as Vue files.markdownItOptions.Type: markdownIt.Options.MarkdownIt options. Visit MarkdownIt's documentation to read more.markdownItSetup.Type: (md: markdownIt) => space.Callback to incorporate plugins to MarkdownIt.wrapperClass.Style: string.Default: markdown-body.The lesson to contribute to the wrapper factor that contains the Fall page.onDemo.Kind:.(.tag: string,.code: strand,.demonstrations: Chart.) => string.You can easily obstruct each demo block and return a personalized HTML cord. This is useful for adding custom-made styling to trial blocks.Additionally, there are actually utils left open in the this context:.escapeHtml: Getaway HTML code to stop it coming from being actually made as HTML.registerComponent: Register a component to become made use of in the demonstration block. This works for enrolling parts that are actually imported from other reports.See example above in the Trial Blocks section.markdownCss.Type: chain.Submit pathway to a stylesheet to use for the Accounting allowance web page. This are going to be actually added making use of so it will simply apply to the accounting allowance page. Valuable for styling just the HTML created by the MarkdownIt plugin.useVOnce.Kind: boolean.Whether to add v-once to the whole entire Accounting allowance webpage. This are going to protect against the Fall page from being actually re-rendered when the Vue part is actually upgraded.Precaution: This will certainly disable trial blocks. Only use this if you possess a big file as well as do not need demo blocks.Related.unplugin-vue-markdown.An additional Vite plugin for compiling Accounting allowance data to Vue parts.This plugin has actually attracted inspiration coming from it yet has a various feature set. This plugin just sustains Vue.js code in code blocks.Github.View Github.