Expand description
Documentation generation for Art files.
This module generates Markdown documentation from Art descriptors, including component catalogs, variant listings, and searchable indexes.
§Example
use vize_carton::Bump;
use vize_musea::{parse_art, ArtParseOptions};
use vize_musea::docs::{generate_component_doc, DocOptions};
let allocator = Bump::new();
let source = r#"
<art title="Button" description="A button component" category="atoms">
<variant name="Primary" default>
<Button>Click me</Button>
</variant>
</art>
"#;
let art = parse_art(&allocator, source, ArtParseOptions::default()).unwrap();
let output = generate_component_doc(&art, &DocOptions::default());
println!("{}", output.markdown);Structs§
- Catalog
Entry - Entry in a component catalog.
- Catalog
Output - Output of catalog generation.
- DocOptions
- Options for documentation generation.
- DocOutput
- Output of documentation generation.
Functions§
- generate_
catalog - Generate a complete component catalog.
- generate_
category_ index - Generate an index page for a specific category.
- generate_
component_ doc - Generate Markdown documentation for a single Art component.
- generate_
tags_ index - Generate a tags index page.
- generate_
variant_ doc - Generate Markdown documentation for a single variant.