Första uppsättningen av temat

1. Börja med att installera alla nödvändiga paket med npm install eller pnpm install, och kör sedan en första byggning för att kontrollera att uppsättningen fungerar med npm run build eller pnpm build.
2. Kopiera Pagefind-bygget (för sökfunktionen på webbplatsen) så att det blir tillgängligt i utvecklingsmiljön. Det här går till olika beroende på operativsystem. Vi har lagt in några kommandon som hjälper dig.
   • För Windows, kör npm run winsearch
   • För OSX eller Linux, kör npm run osxsearch
3. Därefter vill du ställa in i18n för webbplatsen (ett språk eller flera). Kör bara kommandot npm run docs:config-i18n och följ instruktionerna i skriptet så är du igång!
4. Nu kan du anpassa webbplatsen precis som du vill!

Introduktioner till koden

Vi har skapat några kodrundturer som introducerar dig till kodbasen. Du behöver tillägget Code Tour för att se dem i VSCode eller en annan IDE.

Kodstruktur

Koden är strukturerad så att det mesta ligger under katalogen src/docs. Det gör det enkelt att släppa in hela mappen i ett befintligt projekt och lägga till dokumentationsfunktioner på några minuter.

Konfigurationsalternativ

Den övergripande konfigurationen av webbplatsen görs i mappen src/docs/config/. De flesta inställningar ligger i separata språkmappar för att göra översättningar enklare att hantera.

Webbplatsinställningar

Filen src/docs/config/siteSettings.json.ts används för att konfigurera webbplatsens inställningar. Det handlar om saker som om view transitions ska vara aktiverade, om animationer ska vara aktiverade och om kopieringsknappar för länkar ska visas vid rubrikerna i dokumentationen.

Webbplatsdata

Filen src/docs/config/[language]/siteData.json.ts används för att konfigurera webbplatsens data. Det omfattar saker som webbplatsens titel, beskrivning, länkar till sociala medier och standardbild.

Navigeringsdata

Konfigurera navigeringsdata för den övre navigeringsraden i filen src/docs/config/[language]/navData.json.ts.

Sidofältets layout

Konfigurera ordningen på dokumentationens avsnitt i filen src/docs/config/[language]/sidebarNavData.json.ts.

Robots

För att robotar som Google ska hitta rätt sitemap vill du redigera filen public/robots.txt så att den använder din egen domän.

Fler resurser

Allmänt om Astro

Astro letar efter .astro- eller .md-filer i katalogen src/pages/. Varje sida exponeras som en route utifrån sitt filnamn.

Det är inget speciellt med src/components/, men det är där vi brukar lägga komponenter i Astro/React/Vue/Svelte/Preact.

Statiska filer, till exempel bilder, kan läggas i katalogen public/. Vi använder också ofta src/assets för bilder när vi använder Astro assets för bildoptimering.

Kommandon

Alla kommandon körs från projektets rot, i en terminal:

Kommando	Åtgärd
npm install	Installerar beroenden
npm run dev	Startar lokal utvecklingsserver på localhost:4321
npm run build	Bygger din produktionswebbplats till ./dist/
npm run preview	Förhandsgranska bygget lokalt före driftsättning
npm run astro ...	Kör CLI-kommandon som astro add, astro check
npm run astro -- --help	Få hjälp med Astro CLI

Vill du veta mer?

Ta gärna en titt i dokumentationen eller hoppa in på Discord-servern.