Пропустить до содержимого
Starlight

Введение

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

Starlight — это полнофункциональная тема для документации, созданная на основе фреймворка Astro.

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

# создать новый проект с помощью npm
npm create astro@latest -- --template starlight

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

Создание контента с Starlight

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

Форматы файлов

Starlight поддерживает создание контента в форматах Markdown и MDX. (Вы можете добавить поддержку Markdoc, установив экспериментальную интеграцию Astro Markdoc.)

Добавить страницы

Автоматически добавляйте новые страницы на ваш сайт, создавая файлы .md или .mdx в директории src/content/docs/. Добавляйте подпапки для организации ваших файлов и создания множественных сегментов пути:

src/content/docs/hello-world.md => ваш-сайт.com/hello-world
src/content/docs/guides/faq.md => ваш-сайт.com/guides/faq

Типобезопасные метаданные

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

---
title: Привет, мир!
description: Это страница на моем сайте, работающем на Starlight
---

Если вы что-то забудете, Starlight сообщит вам об этом

Развертывание вашего сайта на Starlight

После того как вы создали и настроили свой сайт на Starlight, вы можете развернуть его на веб-сервере или платформе хостинга по вашему выбору, включая Netlify, Vercel, GitHub Pages и так далее.

Узнайте о развертывании сайта на Astro из документации Astro.

Обновление Starlight

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

# Обновление Starlight с npm
npm install @astrojs/starlight@latest

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

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

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

Смотрите пополняющийся список руководств в боковой панели для помощи в добавлении контента и настройке вашего сайта на Starlight.

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

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