Prvotné nastavenie témy

1. Na úvod najprv nainštalujte všetky potrebné balíky príkazom npm install alebo pnpm install a potom spustite prvý build príkazom npm run build alebo pnpm build, aby ste overili, že nastavenie funguje.
2. Skopírujte build Pagefind (pre vyhľadávanie na stránke) tak, aby bol dostupný vo vývojovom prostredí. Postup sa líši podľa operačného systému. Pripravili sme na to niekoľko príkazov.
   • Pre Windows spustite npm run winsearch
   • Pre OSX alebo Linux spustite npm run osxsearch
3. Ďalej si budete chcieť nastaviť i18n konfiguráciu stránky (jeden jazyk alebo viacero). Jednoducho spustite príkaz npm run docs:config-i18n a postupujte podľa pokynov skriptu.
4. Teraz si už môžete stránku upraviť presne podľa svojich predstáv!

Úvodné prehliadky kódu

Pripravili sme niekoľko prehliadok kódu, ktoré Vás uvedú do zdrojového kódu projektu. Na ich zobrazenie vo VSCode alebo inom IDE potrebujete rozšírenie Code Tour.

Štruktúra kódu

Väčšina kódu sa nachádza v adresári src/docs. Vďaka tomu môžete celý tento priečinok jednoducho vložiť do existujúceho projektu a pridať doň funkcie dokumentácie za pár minút.

Možnosti konfigurácie

Celková konfigurácia stránky sa robí v priečinku src/docs/config/. Väčšina nastavení je uložená v samostatných jazykových priečinkoch, aby sa preklady spravovali jednoduchšie.

Nastavenia stránky

Súbor src/docs/config/siteSettings.json.ts slúži na konfiguráciu nastavení stránky. Patrí sem napríklad to, či zapnúť view transitions, či povoliť animácie a či pri nadpisoch dokumentácie zobrazovať tlačidlá na kopírovanie odkazu.

Údaje stránky

Súbor src/docs/config/[language]/siteData.json.ts slúži na konfiguráciu údajov stránky. Patrí sem názov stránky, popis, odkazy na sociálne siete a predvolený obrázok.

Údaje navigácie

Údaje navigácie pre horný navigačný panel nastavíte v súbore src/docs/config/[language]/navData.json.ts.

Rozloženie bočného panela

Poradie sekcií dokumentácie nastavíte v súbore src/docs/config/[language]/sidebarNavData.json.ts.

Robots

Aby roboty ako Google videli správnu sitemap, upravte súbor public/robots.txt tak, aby používal doménu Vášho webu.

Ďalšie zdroje

Všeobecné informácie o Astro

Astro hľadá súbory .astro alebo .md v adresári src/pages/. Každá stránka je sprístupnená ako samostatná cesta podľa názvu svojho súboru.

Priečinok src/components/ nie je nijako výnimočný, ale práve doň radi ukladáme komponenty Astro/React/Vue/Svelte/Preact.

Statické súbory, napríklad obrázky, môžete umiestniť do adresára public/. Pre obrázky často používame aj src/assets, keď na ich optimalizáciu využívame Astro assets.

Príkazy

Všetky príkazy sa spúšťajú z koreňového adresára projektu, z terminálu:

Príkaz	Akcia
npm install	Nainštaluje závislosti
npm run dev	Spustí lokálny vývojový server na localhost:4321
npm run build	Zostaví produkčnú verziu stránky do ./dist/
npm run preview	Zobrazí lokálny náhľad buildu pred nasadením
npm run astro ...	Spustí CLI príkazy ako astro add, astro check
npm run astro -- --help	Zobrazí pomocníka k Astro CLI

Chcete sa dozvedieť viac?

Pokojne si pozrite dokumentáciu alebo sa pripojte na Discord server.