undocs

undocs

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

1星標
1分支
更新於 2/2/2026
SKILL.md
readonlyread-only
name
undocs
description

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

version
"2026.2.1"

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
CLI Commands Development and build commands for undocs core-cli
Configuration Configure documentation site using docs.yaml core-configuration
Navigation Navigation system and icon configuration core-navigation
Project Structure Recommended project structure and organization core-project-structure
Landing Page Landing page configuration and hero customization core-landing-page

Features

Components

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

Content Transformations

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

Additional Features

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

Best Practices

Topic Description Reference
Deployment Deploy undocs sites to various hosting platforms best-practices-deployment
Writing Best practices for structuring and writing content best-practices-writing

You Might Also Like

Related Skills

verify

verify

243K

Use when you want to validate changes before committing, or when you need to check all React contribution requirements.

facebook avatarfacebook
獲取
test

test

243K

Use when you need to run tests for React core. Supports source, www, stable, and experimental channels.

facebook avatarfacebook
獲取

Use when feature flag tests fail, flags need updating, understanding @gate pragmas, debugging channel-specific test failures, or adding new flags to React.

facebook avatarfacebook
獲取

Use when adding new error messages to React, or seeing "unknown error code" warnings.

facebook avatarfacebook
獲取
flow

flow

243K

Use when you need to run Flow type checking, or when seeing Flow type errors in React code.

facebook avatarfacebook
獲取
flags

flags

243K

Use when you need to check feature flag states, compare channels, or debug why a feature behaves differently across release channels.

facebook avatarfacebook
獲取