Вступ
Starlight ─ це повнофункціональна документаційна схема, побудована на основа фреймворку Astro. Цей ґайд допоможе вам розпочати роботу над новим проєктом. Щоби додати Starlight до наявного проєкту Astro, дивіться інструкції з ручного встановлення.
Прудкий старт
Створіть новий проєкт
Створіть новий проєкт Astro + Starlight, виконавши наступну команду в вашому терміналі:
npm create astro@latest -- --template starlightpnpm create astro --template starlightyarn create astro --template starlightЦе створить нову директорію проєкту з усіма необхідними файлами й конфіґурацією для вашого сайту.
Запустіть розробницький сервер
Коли працюєте локально, розробницький сервер Astro дозволяє попередньо переглянути вашу роботу та автоматично оновлює браузер, щойно ви вносите зміни.
Щоби запустити розробницький сервер, виконайте таку команду в теці вашого проєкту:
npm run devpnpm devyarn devУ термінал видрукується URL локального сервера. Відкрийте цю ланку, щоби переглянути сайт.
Додайте контент
Starlight підготовлено, тепер ви можете додавати новий контент або долучати наявні файли!
Формати файлів
Starlight підтримує створення контенту у форматах Markdown і MDX без жодних додаткових налаштувань. Ви можете додати підтримку Markdoc, встановивши експериментальну інтеґрацію Astro Markdoc.
Додайте сторінки
Додавайте нові сторінки на ваш сайт, створюючи файли .md та .mdx у теці src/content/docs/.
Використовуйте підтеки, щоб орґанізовувати файли та створювати множинні сеґменти шляху.
Наприклад, оттака структура файлів зґенерує сторінки за адресами example.com/hello-world і example.com/guides/faq:
Directorysrc/
Directorycontent/
Directorydocs/
Directoryguides/
- faq.md
- hello-world.md
Безпека типів у преамбулі (frontmatter)
У Starlight усі сторінки поділяють спільний налаштовуваний набір властивостей преамбули, якими визначається вигляд сторінки:
---title: Привіт, світ!description: Це сторінка на моїм сайті, що він працює на Starlight!---Якщо ви забудете щось важливе, Starlight сповістить вас про це.
Наступні кроки
- Конфіґурація: Дізнайтеся про поширені параметри в ґайді “Налаштовування Starlight”.
- Навіґація: Спорудить бічну панель у розділі “Навіґація бічною панеллю”.
- Компоненти: Відкрийте вбудовані картки, вкладки та багато іншого в “Компонентах”.
- Розгортування: Опублікуйте власну працю за допомогою посібника “Розгорніть свій сайт” в документації Astro.
Оновлення Starlight
Starlight є інтеґрацією Astro, отже ви можете оновити його так само, як і решту пакетів Astro, ─ виконавши в терміналі команду:
npx @astrojs/upgradepnpm dlx @astrojs/upgradeyarn dlx @astrojs/upgradeПовний список змін до кожного релізу дивіться в списку змін Starlight.
Зневадження Starlight
Використовуйте довідкові сторінки конфіґурація проєкту та індивідуальні налаштуванні преамбули сторінки, щоб упевнитися, що ваш сайт налаштований і функціонує належним чином. Перегляньте ґайди на бічній панелі, щоби дізнатися, як додавати контент і налаштовувати сайт Starlight.
Якщо ви не можете знайти відповідь у цій документації, будь ласка, перегляньте повну документацію Astro. Ваше питання можна вирішити, зрозумівши, як працює Астро загалом, під капотом Starlight.
Ви також можете перевірити відомі проблеми Starlight на GitHub, а також звернутися по допомогу на Discord-сервері Astro до нашої активної, дружньої спільноти! Ставте запитання в гілці #support із теґом “starlight” або відвідайте спеціальну гілку #starlight, щоб обговорити поточну розробку та багато іншого!