JSPM

  • Created
  • Published
  • Downloads 2701
  • Score
    100M100P100Q123403F
  • License MIT

Vite plugin for Musea - Component gallery for Vue components

Package Exports

  • @vizejs/vite-plugin-musea
  • @vizejs/vite-plugin-musea/a11y
  • @vizejs/vite-plugin-musea/autogen
  • @vizejs/vite-plugin-musea/cli
  • @vizejs/vite-plugin-musea/vrt

Readme

@vizejs/vite-plugin-musea

Vite plugin for Musea - Vue component gallery and documentation.

Installation

npm install @vizejs/vite-plugin-musea

Usage

// vite.config.ts
import { defineConfig } from "vite";
import { musea } from "@vizejs/vite-plugin-musea";

export default defineConfig({
  plugins: [
    musea({
      // Art files pattern
      include: "**/*.art.vue",
      // Output directory
      outDir: ".musea",
    }),
  ],
});

Art File Format

<!-- Button.art.vue -->
<art title="Button" component="./Button.vue">
  <variant name="Primary" default>
    <Button variant="primary">Click me</Button>
  </variant>
  <variant name="Disabled">
    <Button disabled>Disabled</Button>
  </variant>
</art>

Commands

# Start dev server
vite dev

# Build gallery
vite build

License

MIT