vuepress-plugin-vue-example
v1.1.9
Published
A Vuepress plugin to display Vue components' live examples and source code inside documentation
Downloads
39
Maintainers
Readme
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.
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
andstyle
- 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 | Firefox | Chrome | Safari | 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/