fumadocs-component-docs
Create component documentation with installation, usage examples, and preview sections. Apply when documenting 8-bit components with proper structure and examples.
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Create component documentation with installation, usage examples, and preview sections. Apply when documenting 8-bit components with proper structure and examples.
How to use
Załaduj umiejętność fumadocs-component-docs do Claude lub kompatybilnego agenta, aby uaktywnić generator dokumentacji komponentów.
Przygotuj informacje o komponencie, który chcesz udokumentować: nazwę, opis funkcjonalności, dostępne warianty i właściwości (props).
Poproś agenta o wygenerowanie dokumentacji dla Twojego komponentu — umiejętność automatycznie zastosuje strukturę ComponentPreview z przykładami kodu.
Dla prostych komponentów (np. Button) umiejętność wygeneruje minimalny przykład; dla złożonych (np. Sheet z subkomponentami) utworzy pełną hierarchię z nagłówkami, opisami i wariantami.
Przejrzyj wygenerowaną dokumentację — zawiera ona sekcje instalacji, przykłady użycia z kodem MDX i interaktywne podglądy gotowe do wstawienia na stronę dokumentacji.
Dostosuj warianty komponentów i opisy w wygenerowanym kodzie MDX, jeśli potrzebujesz zmian — umiejętność zapewnia szablon, który łatwo się rozszerza.