Početno postavljanje teme

1. Za početak najprije instalirajte sve potrebne pakete naredbom npm install ili pnpm install, a zatim pokrenite početnu izradu naredbom npm run build ili pnpm build kako biste provjerili radi li postava ispravno.
2. Kopirajte Pagefind izradu (za pretraživanje web-mjesta) kako bi bila dostupna razvojnom okruženju. Postupak se razlikuje ovisno o operacijskom sustavu. Pripremio sam nekoliko naredbi koje vam mogu pomoći.
   • Za Windows pokrenite npm run winsearch
   • Za OSX ili Linux pokrenite npm run osxsearch
3. Zatim ćete htjeti konfigurirati i18n postavu svojeg web-mjesta (jedan jezik ili više njih). Jednostavno pokrenite naredbu npm run docs:config-i18n i slijedite upute skripte kako biste dovršili postavljanje!
4. Sada možete urediti web-mjesto po svojoj želji!

Uvod u kod

Pripremio sam nekoliko vodiča kroz kod koji vas uvode u bazu koda. Za njihov prikaz u VSCode-u ili nekom drugom IDE-u trebate proširenje Code Tour.

Struktura koda

Kod je strukturiran tako da se većina stavki nalazi u direktoriju src/docs. Zbog toga je tu cijelu mapu lako prenijeti u postojeći projekt i dodati funkcionalnost dokumentacije u samo nekoliko minuta.

Mogućnosti konfiguracije

Cjelokupna konfiguracija web-mjesta obavlja se u mapi src/docs/config/. Većina postavki nalazi se unutar zasebnih mapa po jeziku kako bi se lakše upravljalo prijevodima.

Postavke web-mjesta

Datoteka src/docs/config/siteSettings.json.ts služi za konfiguriranje postavki web-mjesta. To uključuje stvari poput toga hoće li se omogućiti prijelazi prikaza, hoće li se omogućiti animacije i hoće li se prikazivati gumbi za kopiranje poveznice uz naslove u dokumentaciji.

Podaci web-mjesta

Datoteka src/docs/config/[language]/siteData.json.ts služi za konfiguriranje podataka web-mjesta. To uključuje stvari poput naslova web-mjesta, opisa, poveznica na društvene mreže i zadane slike.

Podaci navigacije

Podatke navigacije za gornju navigacijsku traku konfigurirajte u datoteci src/docs/config/[language]/navData.json.ts.

Raspored bočne trake

Redoslijed odjeljaka dokumentacije konfigurirajte u datoteci src/docs/config/[language]/sidebarNavData.json.ts.

Robots

Kako bi roboti poput Googleovog vidjeli ispravnu kartu web-mjesta, uredite datoteku public/robots.txt tako da koristi domenu vašeg web-mjesta.

Više resursa

Opće informacije o Astru

Astro traži .astro ili .md datoteke u direktoriju src/pages/. Svaka se stranica izlaže kao ruta na temelju naziva svoje datoteke.

Nema ničeg posebnog u vezi s src/components/, ali ondje volimo smjestiti sve Astro/React/Vue/Svelte/Preact komponente.

Svi statični resursi, poput slika, mogu se smjestiti u direktorij public/. Često koristim i src/assets za slike kada za optimizaciju slika koristim Astro assets.

Naredbe

Sve se naredbe pokreću iz korijena projekta, iz terminala:

Naredba	Radnja
npm install	Instalira ovisnosti
npm run dev	Pokreće lokalni razvojni poslužitelj na localhost:4321
npm run build	Izrađuje produkcijsko web-mjesto u ./dist/
npm run preview	Pretpregled izrade lokalno, prije objave
npm run astro ...	Pokreće CLI naredbe poput astro add, astro check
npm run astro -- --help	Prikazuje pomoć za Astro CLI

Želite saznati više?

Slobodno pogledajte dokumentaciju ili se pridružite Discord poslužitelju.