# vuepress-plugin-vue-example

---

:fire: **HEADS UP!** You're currently looking at vuepress-plugin-vue-example branch for **Vuepress 1**.  
If you're looking for a Vuepress 2 compatible version of vuepress-plugin-vue-example, [please check out the `next` branch](https://github.com/kouts/vuepress-plugin-vue-example/tree/next).

---

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

| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>IE / Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Safari | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/opera/opera_48x48.png" alt="Opera" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>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/