/vuepress-plugin-vue-example

A Vuepress plugin to display Vue components' live examples and source code inside documentation.

Primary LanguageVueMIT LicenseMIT

vuepress-plugin-vue-example

A Vuepress plugin to display Vue components' live examples and source code inside documentation.

Features

  • Easy to use, with just a single vue-example tag inside .md or .vue files
  • Uses the built-in syntax highlighting features of Vuepress
  • Displays a fully-working live example
  • Splits source code in separate sections for template script and style
  • Capability to strip comments from the source code
  • Capability to add custom code before each section using slots
  • Includes expand/collapse feature in order to save space

Browsers support

IE / Edge
IE / Edge		 Firefox
Firefox		 Chrome
Chrome		 Safari
Safari		 Opera
Opera
IE11, Edge last 2 versions last 2 versions last 2 versions last 2 versions

Documentation and examples https://vuepress-plugin-vue-example.netlify.app/