Nova Context

@nova-design-system/nova-context is a versioned snapshot of Nova's developer and designer documentation. Each package version matches the corresponding Nova Design System release, allowing tools such as search indexes, MCP servers, and chatbots to answer questions using the context for an exact Nova version.

The package contains data only. It does not expose a JavaScript API or install runtime dependencies.

Included context

| Location | Content | | -------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | | output/storybook/ | Component documentation, examples, guides, and migrations for Web Components, React, Vue, Angular, and Blazor. | | output/examples/ | The same component examples as structured JSON, one document per framework, for runtime consumers. | | output/supernova/ | Designer documentation exported from the Nova design system in Supernova. | | output/data/component-metadata.json | Component props, events, methods, and slots for each supported framework. | | output/data/figma-to-tailwind-mapping.json | Figma token to Tailwind mapping. | | output/data/icon-mappings.json | Nova icon metadata and mappings. | | output/data/typography-tokens.json | Typography utilities and their token metadata. | | output/manifest.json | Version, file inventory, and integrity metadata for the snapshot. |

Package layout

output/
├── manifest.json
├── data/
│   ├── component-metadata.json
│   ├── figma-to-tailwind-mapping.json
│   ├── icon-mappings.json
│   └── typography-tokens.json
├── examples/
│   ├── angular.json
│   ├── blazor.json
│   ├── native.json
│   ├── react.json
│   └── vue.json
├── storybook/
│   └── *.md
└── supernova/
    └── *.md

Markdown metadata

Markdown documents start with YAML frontmatter. Depending on the source, this includes fields such as:

• title: Human-readable document title.
• framework: Framework represented by a Storybook document.
• category: Developer or designer documentation category.
• path: Stable path relative to output/.
• url: Link to the corresponding Nova documentation page.
• id or slug: Source identifier for designer documentation.

The remainder of each file is standard Markdown suitable for storing as raw content or splitting into retrieval chunks by heading.

Examples JSON

output/examples/{framework}.json carries the same component examples the Storybook Markdown shows, as data rather than prose, so tools such as a playground can render them at runtime without parsing Markdown. Each document uses schemaVersion: 1 and covers every component for one framework:

{
  "schemaVersion": 1,
  "framework": "react",
  "components": [
    {
      "tag": "nv-button",
      "title": "components/Button/nv-button",
      "description": "The Button component enhances standard HTML buttons...",
      "examples": [
        {
          "name": "Size",
          "description": "Determines how large or small the button appears...",
          "code": "<div className=\"flex gap-4 items-center\">\n  <NvButton size=\"xs\">..."
        }
      ]
    }
  ]
}

• description is omitted on a component or example that has none.
• Only components appear; guides, migrations, and introduction pages stay Markdown-only.
• Props, events, methods, and slots are not repeated here — join data/component-metadata.json on tag.

Manifest

output/manifest.json uses schemaVersion: 1 and contains:

• packageName and novaVersion.
• generatedAt.
• A sorted file inventory with each output-relative path, format, byte size, and SHA-256 checksum.

The manifest does not list or hash itself. Consumers can use the npm tarball integrity for the package and the manifest checksums for individual context files.

Retrieving a version

Install one version when the context should remain available locally:

npm install @nova-design-system/[email protected]

Alternatively, download its tarball without installing it:

npm pack @nova-design-system/[email protected] --ignore-scripts

Available versions can be listed with:

npm view @nova-design-system/nova-context versions --json