# Undocs

> Minimal Documentation Theme and CLI for shared usage across UnJS projects. Use when creating documentation sites with Nuxt, Nuxt Content, and Nuxt UI.

- Skill: `hairyf-skills/undocs` (Agent Skill, multi-file: 25 files)
- Install (CLI): `npx skillmds@latest add hairyf-skills/undocs`
- Raw SKILL.md: https://api.skillmd.com/api/skills/hairyf-skills/undocs/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- Author: hairyf (https://skillmd.com/u/hairyf-skills)
- Updated: 2026-09-09
- Page: https://skillmd.com/skills/hairyf-skills/undocs

---


Undocs is a minimal Documentation Theme and CLI built with Nuxt, Nuxt Content, and Nuxt UI. It provides zero-config documentation sites with elegant CLI wrapper, automatic content transformations, and built-in components for common documentation needs.

> The skill is based on undocs v0.4.15, generated at 2026-01-31.

## Core References

| Topic | Description | Reference |
|-------|-------------|-----------|
| Getting Started | Quick start guide for creating documentation sites | [core-getting-started](references/core-getting-started.md) |
| CLI Commands | Development and build commands for undocs | [core-cli](references/core-cli.md) |
| Configuration | Configure documentation site using docs.yaml | [core-configuration](references/core-configuration.md) |
| Navigation | Navigation system and icon configuration | [core-navigation](references/core-navigation.md) |
| Project Structure | Recommended project structure and organization | [core-project-structure](references/core-project-structure.md) |
| Landing Page | Landing page configuration and hero customization | [core-landing-page](references/core-landing-page.md) |

## Features

### Components

| Topic | Description | Reference |
|-------|-------------|-----------|
| Alerts | Note, tip, important, warning, and caution alert components | [features-alerts](references/features-alerts.md) |
| Package Manager | Cross-package-manager command components (npm, pnpm, yarn, bun, deno) | [features-package-manager](references/features-package-manager.md) |
| Read More | Styled link component for cross-referencing pages | [features-read-more](references/features-read-more.md) |
| Mermaid Diagrams | Render Mermaid diagrams and flowcharts in documentation | [features-mermaid](references/features-mermaid.md) |
| Nuxt UI Prose | Use Nuxt UI Prose components in markdown files | [features-nuxt-ui-prose](references/features-nuxt-ui-prose.md) |
| Custom Icons | Add custom icon collections via .docs/icons | [features-custom-icons](references/features-custom-icons.md) |
| Page Header Links | Copy markdown, open in ChatGPT/Claude | [features-page-header-links](references/features-page-header-links.md) |
| Prose Code Icons | File type icons in code blocks | [features-prose-code-icons](references/features-prose-code-icons.md) |

### Content Transformations

| Topic | Description | Reference |
|-------|-------------|-----------|
| Content Transformations | Automatic markdown transformations (GitHub notes, code groups, steps, config references) | [features-content-transformation](references/features-content-transformation.md) |
| Content Collections | Include/exclude patterns and source configuration | [features-content-collections](references/features-content-collections.md) |

### Additional Features

| Topic | Description | Reference |
|-------|-------------|-----------|
| Blog | Create and manage blog posts | [features-blog](references/features-blog.md) |
| SEO | SEO optimization and Open Graph image generation | [features-seo](references/features-seo.md) |
| Raw Markdown & LLMs | Raw markdown output, content negotiation, /llms.txt | [features-raw-markdown-llms](references/features-raw-markdown-llms.md) |
| Contributors & Sponsors | Display contributors and sponsors on landing page | [features-contributors-sponsors](references/features-contributors-sponsors.md) |
| Automd Integration | Integrate automd for automatic documentation updates | [features-automd](references/features-automd.md) |

## Best Practices

| Topic | Description | Reference |
|-------|-------------|-----------|
| Deployment | Deploy undocs sites to various hosting platforms | [best-practices-deployment](references/best-practices-deployment.md) |
| Writing | Best practices for structuring and writing content | [best-practices-writing](references/best-practices-writing.md) |