https://github.com/kouts/vuepress-plugin-vue-example

A Vuepress plugin to display Vue components' live examples and source code inside documentation.
https://github.com/kouts/vuepress-plugin-vue-example

code example vue vuepress vuepress-plugin

Last synced: 11 months ago
JSON representation

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

Host: GitHub
URL: https://github.com/kouts/vuepress-plugin-vue-example
Owner: kouts
License: mit
Created: 2021-02-12T18:13:45.000Z (almost 5 years ago)
Default Branch: next
Last Pushed: 2024-08-22T08:23:32.000Z (over 1 year ago)
Last Synced: 2025-03-08T21:03:51.177Z (11 months ago)
Topics: code, example, vue, vuepress, vuepress-plugin
Language: JavaScript
Homepage: https://next--vuepress-plugin-vue-example.netlify.app/
Size: 2.2 MB
Stars: 5
Watchers: 2
Forks: 5
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

# vuepress-plugin-vue-example

---

:fire: **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](https://github.com/kouts/vuepress-plugin-vue-example/tree/master).

---

A [Vuepress 2](https://v2.vuepress.vuejs.org/) 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

| [](http://godban.github.io/browsers-support-badges/)
Edge | [](http://godban.github.io/browsers-support-badges/)
Firefox | [](http://godban.github.io/browsers-support-badges/)
Chrome | [](http://godban.github.io/browsers-support-badges/)
Safari | [](http://godban.github.io/browsers-support-badges/)
Opera |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Edge | last 2 versions | last 2 versions | last 2 versions | last 2 versions |