Začetna nastavitev teme

1. Za začetek najprej namestite vse potrebne pakete z ukazom npm install ali pnpm install, nato pa zaženite začetno gradnjo z ukazom npm run build ali pnpm build, da preverite, ali nastavitev deluje.
2. Kopirajte gradnjo Pagefind (za iskanje po strani), da bo na voljo v razvojnem okolju. Postopek se razlikuje glede na operacijski sistem, zato je na voljo nekaj pripravljenih ukazov.
   • V sistemu Windows zaženite npm run winsearch
   • V sistemih OSX ali Linux zaženite npm run osxsearch
3. Nato nastavite i18n za svojo stran (en jezik ali več jezikov). Preprosto zaženite ukaz npm run docs:config-i18n in sledite navodilom skripte.
4. Zdaj lahko stran uredite po svojih željah.

Uvod v kodo

Na voljo je nekaj vodenih ogledov kode, ki vas seznanijo z bazo kode. Za ogled v VSCode ali drugem urejevalniku potrebujete razširitev Code Tour.

Struktura kode

Koda je zasnovana tako, da je večina elementov v mapi src/docs. Zaradi tega lahko celotno mapo preprosto prenesete v obstoječi projekt in v nekaj minutah dodate funkcionalnost dokumentacije.

Možnosti konfiguracije

Splošna konfiguracija strani poteka v mapi src/docs/config/. Večina nastavitev je v ločenih jezikovnih mapah, kar olajša delo s prevodi.

Nastavitve strani

Datoteka src/docs/config/siteSettings.json.ts se uporablja za konfiguracijo nastavitev strani. Te vključujejo na primer, ali naj bodo omogočeni prehodi pogleda, ali naj bodo omogočene animacije in ali naj bodo pri naslovih dokumentacije prikazani gumbi za kopiranje povezave.

Podatki strani

Datoteka src/docs/config/[language]/siteData.json.ts se uporablja za konfiguracijo podatkov strani. Ti vključujejo na primer naslov strani, opis, povezave do družbenih omrežij in privzeto sliko.

Podatki za navigacijo

Podatke za navigacijo v zgornji vrstici nastavite v datoteki src/docs/config/[language]/navData.json.ts.

Postavitev stranske vrstice

Vrstni red razdelkov dokumentacije nastavite v datoteki src/docs/config/[language]/sidebarNavData.json.ts.

Roboti

Da bodo roboti, kot je Googlov, videli pravilen zemljevid strani, uredite datoteko public/robots.txt tako, da bo uporabljala domeno vaše spletne strani.

Več virov

Splošne informacije o Astru

Astro išče datoteke .astro ali .md v mapi src/pages/. Vsaka stran je izpostavljena kot pot na podlagi imena datoteke.

Pri mapi src/components/ ni nič posebnega, vendar tja običajno shranjujemo komponente Astro/React/Vue/Svelte/Preact.

Vsa statična sredstva, na primer slike, lahko shranite v mapo public/. Za slike pogosto uporabljamo tudi mapo src/assets, kadar želimo optimizacijo slik z zmogljivostmi Astra.

Ukazi

Vse ukaze zaženete iz korena projekta, v terminalu:

Ukaz	Dejanje
npm install	Namesti odvisnosti
npm run dev	Zažene lokalni razvojni strežnik na localhost:4321
npm run build	Zgradi produkcijsko stran v mapo ./dist/
npm run preview	Predogled gradnje lokalno, pred objavo
npm run astro ...	Zažene ukaze CLI, kot sta astro add, astro check
npm run astro -- --help	Prikaže pomoč za uporabo Astro CLI

Želite izvedeti več?

Oglejte si dokumentacijo ali se pridružite strežniku Discord.