Documents

undocs

hairyf/skills · updated Apr 8, 2026

$npx skills add https://github.com/hairyf/skills --skill undocs
summary

Zero-config documentation site generator built on Nuxt, Nuxt Content, and Nuxt UI.

  • Includes CLI commands for development and production builds with automatic content transformations
  • Provides built-in markdown components for alerts, package manager commands, diagrams, and cross-page links
  • Supports blog posts, SEO optimization with Open Graph images, and raw markdown output for LLM integration
  • Configurable via docs.yaml with customizable navigation, landing pages, icon collections,
skill.md

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
general reviews

Ratings

4.426 reviews
  • Chaitanya Patil· Dec 20, 2024

    undocs has been reliable in day-to-day use. Documentation quality is above average for community skills.

  • Henry Rao· Dec 16, 2024

    Useful defaults in undocs — fewer surprises than typical one-off scripts, and it plays nicely with `npx skills` flows.

  • Piyush G· Nov 11, 2024

    undocs reduced setup friction for our internal harness; good balance of opinion and flexibility.

  • Shikha Mishra· Oct 2, 2024

    We added undocs from the explainx registry; install was straightforward and the SKILL.md answered most questions upfront.

  • Meera Jain· Sep 21, 2024

    undocs reduced setup friction for our internal harness; good balance of opinion and flexibility.

  • Yash Thakker· Sep 9, 2024

    Keeps context tight: undocs is the kind of skill you can hand to a new teammate without a long onboarding doc.

  • Ama Mehta· Sep 9, 2024

    We added undocs from the explainx registry; install was straightforward and the SKILL.md answered most questions upfront.

  • Dhruvi Jain· Aug 28, 2024

    I recommend undocs for anyone iterating fast on agent tooling; clear intent and a small, reviewable surface area.

  • Sophia Martinez· Aug 28, 2024

    undocs reduced setup friction for our internal harness; good balance of opinion and flexibility.

  • Isabella Singh· Aug 12, 2024

    We added undocs from the explainx registry; install was straightforward and the SKILL.md answered most questions upfront.

showing 1-10 of 26

1 / 3