Przejdź do głównej zawartości

Wprowadzenie do samouczka

Odkryj Docusaurus w niecałe 5 minut.

Pierwsze kroki

Rozpocznij od utworzenia nowej strony.

Lub wypróbuj Docusaurus od razu na docusaurus.new.

Czego będziesz potrzebować

  • Node.js w wersji 20.0 lub nowszej:
    • Podczas instalacji Node.js zaleca się zaznaczenie wszystkich pól wyboru związanych z zależnościami.

Wygeneruj nową stronę

Wygeneruj nową stronę Docusaurus przy użyciu klasycznego szablonu.

Klasyczny szablon zostanie automatycznie dodany do Twojego projektu po uruchomieniu polecenia:

npm init docusaurus@latest my-website classic

Możesz wpisać to polecenie w Wierszu poleceń, Powershell, Terminalu lub dowolnym innym zintegrowanym terminalu edytora kodu.

Polecenie instaluje również wszystkie niezbędne zależności potrzebne do uruchomienia Docusaurus.

Uruchom swoją stronę

Uruchom serwer deweloperski:

cd my-website
npm run start

Polecenie cd zmienia katalog, w którym pracujesz. Aby pracować z nowo utworzoną stroną Docusaurus, musisz przejść do jej katalogu w terminalu.

Polecenie npm run start buduje Twoją witrynę lokalnie i udostępnia ją przez serwer deweloperski, gotowy do wyświetlenia pod adresem http://localhost:3000/.

Otwórz docs/intro.md (tę stronę) i edytuj kilka wierszy: strona odświeża się automatycznie i wyświetla wprowadzone zmiany.