Configurarea inițială a temei

1. Ca să începi, instalează mai întâi toate pachetele necesare cu npm install sau pnpm install, apoi rulează o compilare inițială cu npm run build sau pnpm build, ca să te asiguri că totul funcționează.
2. Copiază build-ul Pagefind (pentru căutarea în site) ca să fie disponibil în mediul de dezvoltare. Pasul diferă în funcție de sistemul tău de operare. Am pregătit câteva comenzi care te ajută.
   • Pentru Windows, rulează npm run winsearch
   • Pentru OSX sau Linux, rulează npm run osxsearch
3. Apoi vei vrea să configurezi setările i18n ale site-ului (o singură limbă sau mai multe). Rulează pur și simplu comanda npm run docs:config-i18n și urmează instrucțiunile scriptului!
4. Acum poți să configurezi site-ul exact cum îți dorești!

Introduceri în cod

Am creat câteva tururi de cod care te ajută să te familiarizezi cu baza de cod. Ai nevoie de extensia Code Tour ca să le vezi în VSCode sau într-un alt IDE.

Structura codului

Codul este structurat cu majoritatea elementelor în directorul src/docs. Astfel poți muta ușor tot acel folder într-un proiect existent și poți adăuga funcționalitatea de documentație în câteva minute.

Opțiuni de configurare

Configurarea generală a site-ului se face în folderul src/docs/config/. Cele mai multe setări stau în foldere separate pentru fiecare limbă, ca să fie mai ușor de gestionat traducerile.

Setările site-ului

Fișierul src/docs/config/siteSettings.json.ts este folosit pentru configurarea setărilor site-ului. Aici stabilești lucruri precum activarea tranzițiilor de vizualizare, activarea animațiilor sau afișarea butoanelor de copiere a linkului pentru titlurile din documentație.

Datele site-ului

Fișierul src/docs/config/[language]/siteData.json.ts este folosit pentru configurarea datelor site-ului. Aici intră titlul site-ului, descrierea, linkurile către rețelele sociale și imaginea implicită.

Datele de navigare

Configurează datele de navigare pentru bara de sus în fișierul src/docs/config/[language]/navData.json.ts.

Structura barei laterale

Configurează ordinea secțiunilor din documentație în fișierul src/docs/config/[language]/sidebarNavData.json.ts.

Roboți

Ca roboții precum cel al Google să vadă sitemapul corect, editează fișierul public/robots.txt și pune domeniul site-ului tău.

Alte resurse

Informații generale despre Astro

Astro caută fișiere .astro sau .md în directorul src/pages/. Fiecare pagină este expusă ca rută în funcție de numele fișierului.

Nu este nimic special la src/components/, dar acolo ne place să punem componentele Astro/React/Vue/Svelte/Preact.

Orice resursă statică, de exemplu imaginile, poate fi pusă în directorul public/. Folosesc frecvent și src/assets pentru imagini, atunci când folosesc resursele Astro pentru optimizarea imaginilor.

Comenzi

Toate comenzile se rulează din rădăcina proiectului, dintr-un terminal:

Comandă	Acțiune
npm install	Instalează dependențele
npm run dev	Pornește serverul local de dezvoltare la localhost:4321
npm run build	Compilează site-ul de producție în ./dist/
npm run preview	Previzualizează local compilarea, înainte de lansare
npm run astro ...	Rulează comenzi CLI precum astro add, astro check
npm run astro -- --help	Obține ajutor pentru folosirea CLI-ului Astro

Vrei să afli mai multe?

Poți să consulți documentația sau să intri pe serverul de Discord.