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