Početno podešavanje teme

1. Da biste započeli, prvo instalirajte sve neophodne pakete komandom npm install ili pnpm install, a zatim pokrenite početni build komandom npm run build ili pnpm build da biste proverili da podešavanje radi.
2. Kopirajte Pagefind build (za pretragu sajta) tako da bude dostupan razvojnom okruženju. Ovo se razlikuje u zavisnosti od vašeg operativnog sistema. Napravio sam nekoliko komandi koje pomažu.
   • Za Windows pokrenite npm run winsearch
   • Za OSX ili Linux pokrenite npm run osxsearch
3. Zatim ćete želeti da podesite i18n za svoj sajt (jedan jezik ili više njih). Jednostavno pokrenite komandu npm run docs:config-i18n i pratite uputstva skripte da biste sve podesili!
4. Sada možete urediti sajt po svojoj želji!

Uvodi u kod

Napravio sam nekoliko obilazaka koda koji vas uvode u kodnu bazu. Da biste ih videli u VSCode-u ili drugom IDE-u, potrebno vam je proširenje Code Tour.

Struktura koda

Kod je organizovan tako da se većina stavki nalazi u direktorijumu src/docs. To olakšava da ceo taj folder prebacite u postojeći projekat i za nekoliko minuta dodate funkcionalnost dokumentacije.

Opcije konfiguracije

Opšta konfiguracija sajta radi se u folderu src/docs/config/. Većina podešavanja nalazi se unutar pojedinačnih jezičkih foldera kako bi rukovanje prevodima bilo jednostavnije.

Podešavanja sajta

Datoteka src/docs/config/siteSettings.json.ts koristi se za konfigurisanje podešavanja sajta. Tu spadaju stvari kao što su da li omogućiti prelaze prikaza, da li omogućiti animacije i da li prikazati dugmad za kopiranje linka na naslovima dokumentacije.

Podaci o sajtu

Datoteka src/docs/config/[language]/siteData.json.ts koristi se za konfigurisanje podataka o sajtu. Tu spadaju stvari kao što su naslov sajta, opis, linkovi ka društvenim mrežama i podrazumevana slika.

Podaci navigacije

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

Raspored bočne trake

Redosled odeljaka dokumentacije podesite u datoteci src/docs/config/[language]/sidebarNavData.json.ts.

Robots

Da bi roboti poput Google-a videli ispravnu mapu sajta, izmenite datoteku public/robots.txt tako da koristi domen vašeg sajta.

Dodatni resursi

Opšte informacije o Astru

Astro traži .astro ili .md datoteke u direktorijumu src/pages/. Svaka stranica je izložena kao ruta na osnovu svog imena datoteke.

Nema ničega posebnog u vezi sa src/components/, ali tu volimo da smestimo Astro/React/Vue/Svelte/Preact komponente.

Svi statički resursi, poput slika, mogu se smestiti u direktorijum public/. Takođe često koristim src/assets za slike kada koristim Astro resurse za optimizaciju slika.

Komande

Sve komande se pokreću iz korena projekta, iz terminala:

Komanda	Radnja
npm install	Instalira zavisnosti
npm run dev	Pokreće lokalni dev server na localhost:4321
npm run build	Gradi produkcioni sajt u ./dist/
npm run preview	Pregled build-a lokalno, pre postavljanja
npm run astro ...	Pokreće CLI komande kao astro add, astro check
npm run astro -- --help	Pomoć za korišćenje Astro CLI-ja

Želite da saznate više?

Slobodno pogledajte dokumentaciju ili se pridružite Discord serveru.