Astro Starlight

Astro Starlight — це тема документації, побудована на веб-фреймворку Astro. Вона надає готову структуру для створення вебсайтів документації, які є швидкими, доступними та легкими в обслуговуванні. На відміну від інших інструментів документації, Starlight надсилає мінімальну кількість JavaScript у браузер, що призводить до швидшого завантаження та кращої продуктивності.

Інструмент підтримує написання контенту у форматах Markdown, MDX та Markdoc, надаючи вам гнучкість у створенні документації. Він включає автоматичне генерування навігації, вбудований пошук на базі Pagefind та адаптивний дизайн, який працює на всіх пристроях. Starlight також підтримує кілька мов з коробки, що робить його придатним для глобальних проєктів документації. Тема є високо налаштовуваною через конфігураційні файли, що дозволяє вам відповідати вашому бренду, зберігаючи простоту налаштування.

Почати роботу з Astro Starlight просто і вимагає лише кілька кроків:

• Встановіть Starlight за допомогою командного рядка, виконавши npm create astro@latest -- --template starlight у вашому терміналі. Це автоматично налаштує все необхідне.

• Після встановлення запустіть сервер розробки командою npm run dev, щоб переглянути ваш сайт документації локально у браузері.

• Додавайте нові сторінки документації, створюючи файли Markdown або MDX у директорії src/content/docs/. Кожен файл автоматично стає сторінкою.

• Налаштуйте параметри сайту у файлі astro.config.mjs. Тут ви можете встановити заголовок сайту, додати посилання на соціальні мережі та налаштувати бічне меню навігації.

• Організуйте сторінки, створюючи папки всередині директорії docs. Starlight автоматично генерує навігацію на основі структури ваших файлів.

• Коли будете готові до публікації, зберіть сайт командою npm run build та розмістіть його на будь-якому сервісі статичного хостингу, як-от Netlify, Vercel або GitHub Pages.

• Швидке генерування статичних сайтів з мінімальним використанням JavaScript

• Вбудований пошук за допомогою Pagefind

• Повна підтримка інтернаціоналізації

• Автоматичне створення навігації

• Включені теми в темному та світлому режимах

• Підтримка Markdown, MDX та Markdoc

• Інтеграція з кількома фреймворками (React, Vue, Svelte)

• Дизайн з орієнтацією на доступність

• Адаптивний макет для мобільних пристроїв

• Налаштовувані теми та кольори

• Посилання для редагування сторінок

• Інтеграція з соціальними мережами

• Оптимізація для SEO