Първоначална настройка

1. За да започнете, първо инсталирайте всички необходими пакети с npm install или pnpm install, след това стартирайте първоначално изграждане, за да се уверите, че настройката работи с npm run build или pnpm build.
2. Копирайте Pagefind изграждането (за търсене в сайта), за да бъде достъпно за dev средата. Това варира в зависимост от вашата операционна система. Създадох няколко команди, за да помогна.
   • За Windows, изпълнете npm run winsearch
   • За OSX или Linux, изпълнете npm run osxsearch
3. След това ще искате да конфигурирате i18n настройката на сайта си (един език или множество). Просто изпълнете командата npm run docs:config-i18n и следвайте инструкциите на скрипта, за да се настроите!
4. Сега можете да настроите сайта по ваш вкус!

Въведение в кода

Създадох няколко обиколки на кода, за да ви запозная с кодовата база. Ще ви е необходимо разширението Code Tour, за да ги видите в VSCode или друга IDE.

Структура на кода

Кодът е структуриран с повечето елементи в директорията src/docs. Това улеснява поставянето на цялата папка в съществуващ проект и добавянето на функционалност за документация за минути.

Опции за конфигурация

Цялостната конфигурация на сайта се прави в папката src/docs/config/. Повечето настройки са в отделни езикови папки, за да се улесни обработката на преводите.

Настройки на сайта

Файлът src/docs/config/siteSettings.json.ts се използва за конфигуриране на настройките на сайта. Те включват неща като дали да се активират преходи на изгледите, дали да се активират анимации и дали да се показват бутони за копиране на връзки за заглавия на документи.

Данни за сайта

Файлът src/docs/config/[language]/siteData.json.ts се използва за конфигуриране на данните на сайта. Това включва неща като заглавието на сайта, описанието, социалните връзки и изображението по подразбиране.

Навигационни данни

Конфигурирайте навигационните си данни за горната навигационна лента във файла src/docs/config/[language]/navData.json.ts.

Странична лента

Конфигурирайте реда на секциите на документацията си във файла src/docs/config/[language]/sidebarNavData.json.ts.

Роботи

За да могат роботи като Google да виждат правилната карта на сайта, ще трябва да редактирате файла public/robots.txt, за да използвате домейна на вашия уебсайт.

Още ресурси

Обща информация за Astro

Astro търси .astro или .md файлове в директорията src/pages/. Всяка страница е изложена като маршрут въз основа на името на файла.

Няма нищо специално за src/components/, но там обичаме да поставяме всички Astro/React/Vue/Svelte/Preact компоненти.

Всички статични ресурси, като изображения, могат да бъдат поставени в директорията public/. Често използвам също src/assets за изображения, когато използвам Astro assets за оптимизация на изображенията.

Команди

Всички команди се изпълняват от корена на проекта, от терминал:

Команда	Действие
npm install	Инсталира зависимостите
npm run dev	Стартира локален dev сървър на localhost:4321
npm run build	Изгражда продукционния сайт в ./dist/
npm run preview	Преглед на изграждането локално, преди разполагане
npm run astro ...	Изпълнява CLI команди като astro add, astro check
npm run astro -- --help	Получаване на помощ за използването на Astro CLI

Искате да научите повече?

Не се колебайте да проверите документацията или да се присъедините към Discord сървъра.