Skip to content

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

License

Notifications You must be signed in to change notification settings

kouts/vuepress-plugin-vue-example

Repository files navigation

vuepress-plugin-vue-example


🔥 HEADS UP! You're currently looking at vuepress-plugin-vue-example next branch for Vuepress 2.

If you're looking for a Vuepress 1 compatible version of vuepress-plugin-vue-example, please check out the master branch.


A Vuepress 2 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 prismjs for syntax highlighting
  • 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

Edge
Edge
Firefox
Firefox
Chrome
Chrome
Safari
Safari
Opera
Opera
Edge last 2 versions last 2 versions last 2 versions last 2 versions

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