技能 docs-creator
📦

docs-creator

安全

Fumadocs-Dokumentationsseiten erstellen

Die Erstellung technischer Dokumentation erfordert eine konsistente Struktur und Routing. Diese Skill hilft Ihnen, gut organisierte MDX-Dokumentationsseiten mit Fumadocs zu erstellen und behandelt Frontmatter, Navigationsmetadaten und Icon-Integration automatisch.

支援: Claude Codex Code(CC)
📊 70 充足
1

下載技能 ZIP

2

在 Claude 中上傳

前往 設定 → 功能 → 技能 → 上傳技能

3

開啟並開始使用

測試它

正在使用「docs-creator」。 Create a troubleshooting page with the AlertCircle icon

預期結果:

I created src/content/docs/troubleshooting.mdx with frontmatter containing title: Troubleshooting, description: Common issues and solutions, and icon: AlertCircle. The page is now accessible at /docs/troubleshooting.

正在使用「docs-creator」。 Set up a components section with meta.json organizing button, form, and modal pages

預期結果:

I created src/content/docs/components/meta.json with title: UI Components, icon: Package, and pages array containing button, form, and modal. The section will appear in the sidebar with proper ordering.

安全審計

安全
v6 • 1/21/2026

This skill is safe for publication. All 47 static findings are false positives from the analyzer misinterpreting Markdown syntax as code. The skill contains only documentation and reference materials with no executable code, network requests, or file system operations.

3
已掃描檔案
712
分析行數
0
發現項
6
審計總數
未發現安全問題
審計者: claude 查看審計歷史 →

品質評分

38
架構
100
可維護性
87
內容
21
社群
100
安全
91
規範符合性

你能建構什麼

API-Dokumentationsstruktur

Erstellen Sie einen vollständigen API-Referenzbereich mit Endpunktdokumentation, Authentifizierungsanleitungen und Codebeispielen, die in einer logischen Hierarchie organisiert sind.

Produktdokumentation

Erstellen Sie benutzerorientierte Hilfedokumentation mit Anleitungen für den Einstieg, Feature-Durchgängen und Fehlerbehebungsabschnitten mit entsprechender Navigation.

Internes Wissensdatenbank

Organisieren Sie Teamdokumentation einschließlich Onboarding-Anleitungen, Architekturentscheidungen und Entwicklungs-Workflows in einer durchsuchbaren Struktur.

試試這些提示

Grundlegende Dokumentationsseite erstellen
Create a getting started page at src/content/docs/getting-started.mdx with title Getting Started and description Quick start guide for new users
API-Referenzbereich erstellen
Create an API folder in docs with a meta.json that organizes pages for authentication, endpoints, and webhooks with the Webhook icon
Verschachtelte Dokumentation hinzufügen
Create a guides/advanced folder with meta.json and add pages for caching, performance, and security with appropriate icons
Vorhandene Seiten organisieren
Update the meta.json in src/content/docs to reorder pages putting introduction first, then installation, configuration, and add a separator before advanced topics

最佳實務

  • Fügen Sie immer Titel und Beschreibung in MDX-Frontmatter für SEO und Suchfunktionalität ein
  • Verwenden Sie beschreibende Lucide-Icon-Namen, die zum Inhaltsthema passen, um die visuelle Navigation zu verbessern
  • Organisieren Sie zusammengehörige Seiten in Ordnern mit meta.json, um eine klare Dokumentationshierarchie zu maintained

避免

  • Das Erstellen von Seiten ohne Frontmatter führt zu fehlenden Metadaten und schlechter Suchindexierung
  • Die Verwendung nicht existierender Lucide-Icon-Namen verursacht Rendering-Fehler in der Sidebar
  • Das Platzieren von Seiten außerhalb von src/content/docs/ wird das Fumadocs-Routing-System brechen

常見問題

Welches Dateiformat sollten Dokumentationsseiten verwenden?
Verwenden Sie das MDX-Format mit der .mdx-Erweiterung. MDX ermöglicht es Ihnen, Markdown mit React-Komponenten von Fumadocs UI zu kombinieren.
Wie steuere ich die Reihenfolge der Seiten in der Sidebar?
Erstellen Sie eine meta.json-Datei im Ordner und listen Sie die Dateinamen der Seiten in der gewünschten Reihenfolge im pages-Array auf.
Kann ich benutzerdefinierte Icons für Dokumentationsabschnitte verwenden?
Sie können jeden Lucide-Icon-Namen verwenden. Konsultieren Sie die Lucide-Icon-Bibliothek unter lucide.dev, um verfügbare Icon-Namen zu finden.
Wo sollte ich Dokumentationsbilder und Assets platzieren?
Der Skill konzentriert sich auf Seitenstruktur und Metadaten. Die Asset-Platzierung hängt von Ihrer Fumadocs-Konfiguration ab, typischerweise in einem public- oder static-Ordner.
Wie wirken sich verschachtelte Ordner auf die URL-Struktur aus?
Ordner erstellen automatisch URL-Segmente. Zum Beispiel wird api/auth.mdx zu /docs/api/auth im Browser.
Ändert dieser Skill die bestehende Fumadocs-Konfiguration?
Nein, dieser Skill erstellt nur Inhaltsseiten und Navigationsmetadaten. Er setzt voraus, dass Fumadocs bereits in Ihrem Projekt installiert und konfiguriert ist.

開發者詳情

檔案結構