Введение

Starlight — это полнофункциональная тема для документации, созданная на основе фреймворка Astro. Это руководство поможет вам начать работу над новым проектом. См. инструкции по ручной настройке, чтобы добавить Starlight в существующий проект Astro.

Быстрый старт

Создание нового проекта

Вы можете создать новый проект на базе Astro + Starlight, используя следующую команду:

npm

npm create astro@latest -- --template starlight

pnpm

pnpm create astro --template starlight

Yarn

yarn create astro --template starlight

Это создаст новую директорию проекта со всеми необходимыми файлами и настройками для вашего сайта.

Посмотрите это в действии

Попробуйте Starlight в вашем браузере: откройте шаблон на StackBlitz.

Запуск сервера разработки

При локальной работе сервер разработки Astro позволяет предварительно просмотреть вашу работу и автоматически обновляет ваш браузер при внесении изменений.

Внутри каталога вашего проекта выполните следующую команду, чтобы запустить сервер разработки:

npm

npm run dev

pnpm

pnpm dev

Yarn

yarn dev

На ваш терминал будет отправлено сообщение с URL-адресом вашего локального предварительного просмотра. Откройте этот URL-адрес, чтобы начать просмотр вашего сайта.

Добавление контента

Starlight готов к созданию нового контента или к интеграции уже существующих файлов!

Добавляйте новые страницы на свой сайт, создавая файлы Markdown в каталоге src/content/docs/.

Подробнее о файловой маршрутизации и поддержке файлов MDX и Markdoc читайте в руководстве Страницы.

Следующие шаги

• Настройка: Узнайте об общих опциях в главе Настройка Starlight.
• Навигация. Настройте боковую панель с помощью руководства Навигация по боковой панели.
• Компоненты. Узнайте о встроенных карточках, вкладках и многом другом в руководстве Компоненты.
• Развёртывание. Опубликуйте свою работу с помощью руководства Развёртывание вашего сайта в документации Astro.

Обновление Starlight

Совет

Поскольку Starlight ещё в статусе beta, будут частые обновления и улучшения. Не забывайте регулярно обновлять Starlight!

Starlight является интеграцией Astro и обновляется так же, как любая интеграция @astrojs/*:

npm

npx @astrojs/upgrade

pnpm

pnpm dlx @astrojs/upgrade

Yarn

yarn dlx @astrojs/upgrade

Вы можете увидеть полный список изменений, сделанных в каждом релизе, в списке изменений Starlight.

Устранение проблем со Starlight

Используйте справочные страницы конфигурация проекта и конфигурация метаданных отдельной страницы, чтобы убедиться, что ваш сайт Starlight настроен и работает правильно. См. руководства на боковой панели, чтобы получить помощь в добавлении контента и настройке вашего сайта Starlight.

Если вы не можете найти ответ в этой документации, пожалуйста, посетите полную документацию Astro. На ваш вопрос можно ответить, если вы поймете, как работает Astro в целом в рамках темы Starlight.

Вы также можете узнать про любые известные проблемы Starlight на GitHub и получить помощь в Discord Astro от нашего активного, дружелюбного сообщества! Задавайте вопросы на нашем форуме #support с тегом “starlight”, или посетите наш специальный канал #starlight, чтобы обсудить текущую разработку и многое другое!