JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 17
  • Score
    100M100P100Q57818F
  • License MIT

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

Package Exports

  • vuepress-plugin-vue-example
  • vuepress-plugin-vue-example/src/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (vuepress-plugin-vue-example) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

vuepress-plugin-vue-example

🔥 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 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/