Astro Starlight

Astro Starlight to motyw dokumentacji zbudowany na frameworku webowym Astro. Zapewnia gotową strukturę do tworzenia stron dokumentacyjnych, które są szybkie, dostępne i łatwe w utrzymaniu. W przeciwieństwie do innych narzędzi do dokumentacji, Starlight wysyła do przeglądarki minimalną ilość JavaScript, co skutkuje szybszym ładowaniem i lepszą wydajnością.

Narzędzie obsługuje pisanie treści w formatach Markdown, MDX i Markdoc, dając Ci elastyczność w tworzeniu dokumentacji. Zawiera automatyczne generowanie nawigacji, wbudowaną wyszukiwarkę opartą na Pagefind oraz responsywny design działający na wszystkich urządzeniach. Starlight obsługuje również wiele języków od razu po wyjęciu z pudełka, co czyni go odpowiednim do globalnych projektów dokumentacyjnych. Motyw jest wysoce konfigurowalny za pomocą plików konfiguracyjnych, pozwalając dopasować go do Twojej marki, zachowując jednocześnie prostotę konfiguracji.

Rozpoczęcie pracy z Astro Starlight jest proste i wymaga tylko kilku kroków:

• Zainstaluj Starlight, używając wiersza poleceń i uruchamiając npm create astro@latest -- --template starlight w terminalu. To automatycznie wszystko skonfiguruje.

• Po instalacji uruchom serwer deweloperski za pomocą npm run dev, aby lokalnie podejrzeć swoją stronę dokumentacji w przeglądarce.

• Dodaj nowe strony dokumentacji, tworząc pliki Markdown lub MDX w katalogu src/content/docs/. Każdy plik automatycznie staje się stroną.

• Skonfiguruj ustawienia swojej strony w pliku astro.config.mjs. Możesz tam ustawić tytuł strony, dodać linki do mediów społecznościowych oraz dostosować pasek nawigacji.

• Organizuj strony, tworząc foldery wewnątrz katalogu docs. Starlight automatycznie generuje nawigację na podstawie struktury plików.

• Gdy będziesz gotowy do publikacji, zbuduj stronę za pomocą npm run build i wdroż ją na dowolnej usłudze hostingu statycznego, takiej jak Netlify, Vercel czy GitHub Pages.

• Szybkie generowanie statycznych stron z minimalnym użyciem JavaScript

• Wbudowana wyszukiwarka z Pagefind

• Pełne wsparcie dla internacjonalizacji

• Automatyczne generowanie nawigacji

• W zestawie motywy jasny i ciemny

• Wsparcie dla Markdown, MDX i Markdoc

• Integracja z wieloma frameworkami (React, Vue, Svelte)

• Projektowanie z myślą o dostępności

• Responsywny układ na urządzenia mobilne

• Możliwość dostosowania motywów i kolorów

• Linki do edycji stron

• Integracja z mediami społecznościowymi

• Optymalizacja SEO