nuxt-ui

Generate Nuxt UI component Markdown documentation from the official repository.

78|8|Updated Nov 7, 2022
One-click install
npx skills add https://github.com/incubrain/foundry --skill nuxt-ui-incubrain
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: nuxt-ui
Source: https://github.com/incubrain/foundry/tree/main/.claude/skills/nuxt-ui
Command: npx skills add https://github.com/incubrain/foundry --skill nuxt-ui-incubrain

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This skill automates the generation of Nuxt UI component documentation.

Core Features & Use Cases

  • Auto-generates per-component Markdown docs (components/*.md) by pulling data from the Nuxt UI repo.
  • Builds an index (references/components.md) to provide a single reference for all components and categories.
  • Keeps docs in sync with the upstream Nuxt UI docs by parsing frontmatter and content.

Quick Start

Run the nuxt-ui skill to generate component docs locally using the included script.

Frequently Asked Questions about nuxt-ui

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I auto-generate Nuxt UI component documentation from the official repo?▼

You can auto-generate Nuxt UI component docs by running this skill, which clones the official Nuxt UI repo, parses frontmatter and content via a TypeScript script, and writes per-component Markdown files plus an index.

What is the best way to keep Nuxt UI Markdown docs in sync with the upstream repository?▼

The best way to keep Nuxt UI docs in sync is using this skill to parse the upstream Nuxt UI repo frontmatter and content, then regenerate per-component Markdown files and an index automatically.

Do I need Node.js installed locally to generate Nuxt UI component Markdown files?▼

Yes, Node.js is required locally. This skill relies on a TypeScript script to read frontmatter from the cloned Nuxt UI repo and write the Markdown documentation files with minimal local tooling.

Can I use this to generate an index file for all my Nuxt UI components?▼

Yes, you can generate an index file for Nuxt UI components. The skill builds a references/components.md index file that provides a single reference for all components and categories pulled from the Nuxt UI repo.

How does parsing Nuxt UI frontmatter work for generating component docs?▼

Parsing Nuxt UI frontmatter works by cloning the Nuxt UI repo, reading frontmatter and content from each component, and using a TypeScript script to transform that data into structured per-component Markdown files.