Første opsætning af temaet

1. Start med at installere alle nødvendige pakker med npm install eller pnpm install, og kør derefter et første build med npm run build eller pnpm build for at sikre dig, at opsætningen virker.
2. Kopiér Pagefind-buildet (til søgning på sitet), så det er tilgængeligt i udviklingsmiljøet. Det afhænger af dit styresystem. Vi har lavet et par kommandoer, der hjælper dig.
   • På Windows skal du køre npm run winsearch
   • På OSX eller Linux skal du køre npm run osxsearch
3. Derefter skal du konfigurere sitets i18n-opsætning (ét sprog eller flere). Kør blot kommandoen npm run docs:config-i18n, og følg instruktionerne i scriptet, så er du klar!
4. Nu kan du sætte sitet op, præcis som du vil have det!

Introduktion til koden

Vi har lavet et par code tours, der introducerer dig til kodebasen. Du skal bruge udvidelsen Code Tour for at se dem i VSCode eller en anden IDE.

Kodestruktur

Koden er struktureret, så det meste ligger under mappen src/docs. Det gør det nemt at lægge hele mappen ind i et eksisterende projekt og tilføje dokumentationsfunktioner på få minutter.

Konfigurationsmuligheder

Den overordnede konfiguration af sitet sker i mappen src/docs/config/. De fleste indstillinger ligger i mapper per sprog, så oversættelser er lettere at håndtere.

Indstillinger for sitet

Filen src/docs/config/siteSettings.json.ts bruges til at konfigurere sitets indstillinger. Det er for eksempel, om view transitions skal være slået til, om animationer skal være slået til, og om der skal vises knapper til at kopiere links ved overskrifter i dokumentationen.

Sitets data

Filen src/docs/config/[language]/siteData.json.ts bruges til at konfigurere sitets data. Det er blandt andet sitets titel, beskrivelse, links til sociale medier og standardbillede.

Navigationsdata

Konfigurér navigationsdata til den øverste navigationsbjælke i filen src/docs/config/[language]/navData.json.ts.

Layout for sidebjælken

Konfigurér rækkefølgen af dokumentationens sektioner i filen src/docs/config/[language]/sidebarNavData.json.ts.

Robots

For at robotter som Googles kan finde det rigtige sitemap, skal du rette filen public/robots.txt, så den bruger dit eget domæne.

Flere ressourcer

Generel information om Astro

Astro leder efter .astro- eller .md-filer i mappen src/pages/. Hver side bliver eksponeret som en rute ud fra sit filnavn.

Der er ikke noget særligt ved src/components/, men det er der, vi godt kan lide at lægge komponenter til Astro/React/Vue/Svelte/Preact.

Statiske filer som billeder kan lægges i mappen public/. Vi bruger også ofte src/assets til billeder, når vi anvender Astro assets til billedoptimering.

Kommandoer

Alle kommandoer køres fra projektets rod i en terminal:

Kommando	Handling
npm install	Installerer afhængigheder
npm run dev	Starter lokal dev-server på localhost:4321
npm run build	Bygger dit produktionssite til ./dist/
npm run preview	Se dit build lokalt, før du deployer
npm run astro ...	Kør CLI-kommandoer som astro add, astro check
npm run astro -- --help	Få hjælp til Astro CLI

Vil du vide mere?

Kig endelig i dokumentationen, eller hop ind på Discord-serveren.