Docusaurus

Docusaurus to generator statycznych stron zbudowany w oparciu o React i Node.js. Przetwarza Twoje pliki Markdown i tworzy kompletną stronę dokumentacji ze wszystkimi funkcjami, których oczekują użytkownicy. W przeciwieństwie do tworzenia strony od podstaw, Docusaurus zajmuje się trudnymi aspektami za Ciebie.

Narzędzie korzysta z MDX, co oznacza, że możesz dodawać interaktywne komponenty React bezpośrednio w swoich plikach Markdown. Sprawia to, że Twoja dokumentacja jest bardziej angażująca bez dodatkowej pracy. Posiada wbudowaną wyszukiwarkę opartą na Algolii, zarządzanie wersjami dla różnych wydań produktu oraz wsparcie dla ponad 70 języków dzięki narzędziom do tłumaczeń.

Ponieważ tworzy pliki statyczne, Twoja dokumentacja ładuje się szybko i może być hostowana wszędzie. Strony działają świetnie na urządzeniach mobilnych i spełniają nowoczesne standardy internetowe pod względem szybkości i dostępności.

Rozpoczęcie pracy z Docusaurus jest proste i zajmuje tylko kilka minut:

• Zainstaluj Node.js w wersji 20 lub wyższej na swoim komputerze, a następnie uruchom polecenie instalacyjne w terminalu, aby utworzyć nową stronę.

• Pisz swoją dokumentację w plikach Markdown w folderze docs. Każdy plik staje się stroną na Twojej witrynie.

• Dostosuj wygląd i styl, edytując plik konfiguracyjny. Możesz zmieniać kolory, dodać swoje logo oraz ustawić menu nawigacyjne.

• Użyj polecenia podglądu lokalnego, aby na bieżąco widzieć zmiany w przeglądarce podczas pracy.

• Dodawaj wpisy na blogu, tworząc pliki Markdown w folderze blog z datami w nazwie pliku.

• Gdy będziesz gotowy do publikacji, uruchom polecenie build, aby wygenerować pliki statyczne, a następnie prześlij je na dowolny hosting, taki jak GitHub Pages, Netlify czy Vercel.

Narzędzie zawiera szczegółowe przewodniki oraz pomocną społeczność, jeśli napotkasz trudności.

• Darmowy i otwartoźródłowy na licencji MIT

• Zbudowany w React i Node.js

• Pisanie treści w Markdown i MDX

• Wbudowane wyszukiwanie z Algolia DocSearch

• Zarządzanie wersjami dla wydań produktu

• Wsparcie dla ponad 70 języków

• Blog i dokumentacja na jednej stronie

• Tryb ciemny i responsywny design

• Szybkie generowanie statycznych stron

• Łatwa publikacja na dowolnym hostingu