Fumadocs
Fumadocs to darmowe, otwarte oprogramowanie do tworzenia dokumentacji dla deweloperów React, które sprawia, że budowanie pięknych, szybkich i elastycznych stron dokumentacji jest proste.
Czym jest Fumadocs
Fumadocs to framework do dokumentacji, który pomaga deweloperom tworzyć profesjonalne strony dokumentacyjne za pomocą React i Next.js. W przeciwieństwie do tradycyjnych narzędzi do dokumentacji, daje pełną kontrolę nad treścią i designem, jednocześnie automatycznie obsługując skomplikowane elementy.
Obsługuje pisanie treści w Markdown i MDX, co oznacza, że możesz używać prostego formatowania tekstu lub dodawać interaktywne komponenty React. Framework zawiera wbudowaną wyszukiwarkę, podświetlanie składni oraz piękne, gotowe motywy. Działa również z dowolnym źródłem treści, niezależnie od tego, czy przechowujesz dokumentację w plikach, bazie danych czy systemie zarządzania treścią.
Fumadocs składa się z trzech części: warstwy treści do zarządzania dokumentacją, biblioteki rdzeniowej oferującej funkcje takie jak wyszukiwanie oraz biblioteki UI z pięknymi komponentami. Możesz używać tylko tego, czego potrzebujesz.
Jak używać Fumadocs
Rozpoczęcie pracy z Fumadocs jest proste. Oto kroki:
Zainstaluj framework uruchamiając w terminalu polecenie
npm create fumadocs-app. Wybierz preferowany framework React oraz źródło treści, gdy pojawi się odpowiedni komunikat.Twórz treści w plikach MDX w folderze docs. Używaj prostej składni Markdown z możliwością dodawania komponentów React dla elementów interaktywnych.
Dostosuj wygląd za pomocą Tailwind CSS. Możesz zmieniać kolory, układy i style, aby dopasować je do swojej marki, bez konieczności nauki nowego systemu.
Dodaj funkcję wyszukiwania łącząc Orama lub Algolia za pomocą kilku linijek kodu. Framework zajmie się resztą automatycznie.
Użyj narzędzia CLI, aby dodać interaktywne komponenty, takie jak zakładki, wyróżnienia i bloki kodu, za pomocą polecenia
npx @fumadocs/cli add.Wdróż swoją stronę na Vercel, Netlify lub dowolnej usłudze hostingowej obsługującej aplikacje Next.js.
Funkcje Fumadocs
Darmowy i otwartoźródłowy framework
Współpracuje z Next.js, React Router i innymi frameworkami React
Pisanie treści w Markdown i MDX
Wbudowane wyszukiwanie z obsługą Orama i Algolia
Generator dokumentacji OpenAPI
Integracja TypeScript Twoslash
Piękne, gotowe komponenty UI
Narzędzie wiersza poleceń do łatwej konfiguracji
Podświetlanie składni za pomocą Shiki
Wysoka możliwość dostosowania dzięki Tailwind CSS
Ceny Fumadocs
Open Source
Free
- Kompletny system dokumentacji
- Nielimitowana liczba witryn dokumentacyjnych
- Obsługa MDX i Markdown
- Wbudowana integracja wyszukiwania
- Generator dokumentacji OpenAPI
- Wsparcie TypeScript Twoslash
- Piękne komponenty interfejsu użytkownika
- Narzędzie CLI w zestawie
- Podświetlanie składni
- Pełny dostęp do kodu źródłowego
Przypadki użycia Fumadocs
Kto może skorzystać z Fumadocs
Repozytorium Fumadocs
Zobacz na Github| Gwiazdki | 9,379 |
| Forki | 522 |
| Wiek repozytorium | 2 lat |
| Ostatni commit | 19 dni temu |
FAQ o Fumadocs
Podziel się swoim doświadczeniem z Fumadocs
Zobacz co użytkownicy mówią o Fumadocs
0 Recenzje
Jeszcze brak recenzji
Bądź pierwszym, który zrecenzuje Fumadocs
Osadź odznaki Fumadocs
Pokaż swojej społeczności, że Fumadocs jest polecane na Tool Questor. Dodaj te piękne odznaki do swojej strony internetowej, dokumentacji lub profili społecznościowych, aby zwiększyć wiarygodność i przyciągnąć więcej ruchu.
