vize_musea 0.2.0

Musea - Component gallery and documentation for Vize Vue components
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

# vize_musea

**Musea** - Component gallery and documentation for Vize Vue components.

<p align="center">
  <img src="https://raw.githubusercontent.com/ubugeeei/vize/main/crates/vize_musea/logo.svg" alt="vize_musea logo" width="200" />
</p>

## Name Origin

**Musea** (plural of museum) represents a gallery space where art is displayed and documented. Similarly, `vize_musea` provides a gallery for Vue components, allowing developers to view and interact with components in isolation - similar to Storybook.

## Features

- **Component Gallery** - Browse Vue components visually
- **Art Files** - Document components with `*.art.vue`
- **Variants** - Showcase component states
- **Design Tokens** - Centralized design system (Palette)

## Usage

### Art File Parser

```rust
use vize_musea::art::{parse_art, ArtDescriptor};

let art = parse_art(source)?;
println!("Title: {}", art.title);
for variant in art.variants {
    println!("  - {}", variant.name);
}
```

### Design Tokens (Palette)

```rust
use vize_musea::palette::{Palette, Token};

let palette = Palette::from_file("palette.toml")?;
let color = palette.get("colors.primary")?;
```

### Docs Generator

```rust
use vize_musea::docs::generate_docs;

let markdown = generate_docs(&art)?;
```

## License

MIT