undocs について
Nuxt ベースのドキュメントテーマおよび CLI である undocs の利用を案内するスキルです。サイトの作成と設定に加え、コンポーネント、コンテンツ変換、ブログ、SEO、LLM 向けコンテンツを扱います。
主な機能
- 01undocs の初期化と CLI 案内
- 02docs.yaml によるサイト設定
- 03ドキュメントのナビゲーションとホームページ調整
- 04Markdown の変換とコンポーネント
- 05ブログ、SEO、LLM 向け機能
活用シーン
- 01undocs でドキュメントサイトを作成
- 02サイトのナビゲーションとホームページを設定
- 03ドキュメントに Mermaid 図やアラートを追加
- 04生の Markdown と /llms.txt を提供
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ hairyf/ skills --skill undocsインストール後、Claude Code で/undocsを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
GENERATION.mdreferences/best-practices-deployment.mdbest-practices-writing.mdcore-cli.mdcore-configuration.mdcore-getting-started.mdcore-landing-page.mdcore-navigation.mdcore-project-structure.mdfeatures-alerts.mdfeatures-automd.mdfeatures-blog.mdfeatures-content-collections.mdfeatures-content-transformation.mdfeatures-contributors-sponsors.mdfeatures-custom-icons.mdfeatures-mermaid.mdfeatures-nuxt-ui-prose.mdfeatures-package-manager.mdfeatures-page-header-links.mdfeatures-prose-code-icons.mdfeatures-raw-markdown-llms.mdfeatures-read-more.mdfeatures-seo.md詳細
Undocs は、Nuxt、Nuxt Content、Nuxt UI で構築された、ミニマルなドキュメントテーマおよび CLI です。洗練された CLI ラッパー、自動コンテンツ変換、一般的なドキュメント作成に必要な組み込みコンポーネントを備えた、設定不要のドキュメントサイトを提供します。
このスキルは undocs v0.4.15 に基づいており、2026-01-31 に生成されました。
主なリファレンス
| トピック | 説明 | リファレンス |
|---|---|---|
| はじめに | ドキュメントサイトを作成するためのクイックスタートガイド | core-getting-started |
| CLI コマンド | undocs の開発およびビルド用コマンド | core-cli |
| 設定 | docs.yaml を使用したドキュメントサイトの設定 | core-configuration |
| ナビゲーション | ナビゲーションシステムとアイコンの設定 | core-navigation |
| プロジェクト構成 | 推奨されるプロジェクトの構成と整理方法 | core-project-structure |
| ランディングページ | ランディングページの設定とヒーローのカスタマイズ | core-landing-page |
機能
コンポーネント
| トピック | 説明 | リファレンス |
|---|---|---|
| アラート | ノート、ヒント、重要、警告、注意のアラートコンポーネント | features-alerts |
| パッケージマネージャー | 複数のパッケージマネージャーに対応したコマンドコンポーネント(npm、pnpm、yarn、bun、deno) | features-package-manager |
| さらに読む | ページ間の相互参照に使えるスタイル付きリンクコンポーネント | features-read-more |
| Mermaid 図 | ドキュメント内で Mermaid の図やフローチャートをレンダリング | features-mermaid |
| Nuxt UI Prose | Markdown ファイルで Nuxt UI Prose コンポーネントを使用 | features-nuxt-ui-prose |
| カスタムアイコン | .docs/icons からカスタムアイコンコレクションを追加 | features-custom-icons |
| ページヘッダーのリンク | Markdown をコピーし、ChatGPT/Claude で開く | features-page-header-links |
| Prose コードアイコン | コードブロックにファイルタイプのアイコンを表示 | features-prose-code-icons |
コンテンツ変換
| トピック | 説明 | リファレンス |
|---|---|---|
| コンテンツ変換 | Markdown の自動変換(GitHub ノート、コードグループ、ステップ、設定の参照) | features-content-transformation |
| コンテンツコレクション | include/exclude パターンとソース設定 | features-content-collections |
その他の機能
| トピック | 説明 | リファレンス |
|---|---|---|
| ブログ | ブログ記事の作成と管理 | features-blog |
| SEO | SEO の最適化と Open Graph 画像の生成 | features-seo |
| 生の Markdown と LLM | 生の Markdown 出力、コンテンツネゴシエーション、/llms.txt | features-raw-markdown-llms |
| コントリビューターとスポンサー | ランディングページにコントリビューターとスポンサーを表示 | features-contributors-sponsors |
| Automd の統合 | Automd を統合してドキュメントを自動更新 | features-automd |
ベストプラクティス
| トピック | 説明 | リファレンス |
|---|---|---|
| デプロイ | さまざまなホスティングプラットフォームに undocs サイトをデプロイ | best-practices-deployment |
| 執筆 | コンテンツの構成と執筆に関するベストプラクティス | best-practices-writing |
コメント
Markdown 対応