LysDocs

Lysators Dokumentation

På LysDocs hittar du information om Lysators tjänster, guider för diverse teknik och tips för hur man kommer igång som ny medlem. Du är varm välkommen att bidra till att förbättra lysdocs om du har ideér.

Lägg till och redigera nya artiklar till datorhandboken

Utvecklingsmiljön

1. Klona ner handboksrepot härifrån med

   HTTPS

   git clone https://forge.lysator.liu.se/lysdocs/lysdocs.git

   SSH

   git clone ssh://git@forge.lysator.liu.se/lysdocs/lysdocs.git

   • SSH

2. Navigera till toppen av den nedhämtade katalogen och kör

   npm i

   för att installera alla beroenden

3. För att starta utvecklingsservern kör

   npm run dev

4. Öppna nu din webbläsare och navigera till http://localhost:4321/ för att se sidan lokalt

5. Mer information om Starlight går att hitta på https://starlight.astro.build/

Sidredigering

1. Checka ut en egen gren med

   git checkout -b *<namn på din gren>*

2. Gör dina önskade ändringar, spara dem med git add *<filnamn>* och git commit.
3. Tryck upp dina önskade ändringar till gitlab med git push och logga in på https://forge.lysator.liu.se/lysdocs/lysdocs för att skapa en pull request.
4. Din request ses över och mergas till eller nekas från master.

Skapa nya sidor

1. Skapa en .md eller .mdx fil i src/content/docs/[kategori]/.
2. Ge den en frontmatter med en titel

   ---
   title: "Min nya sida"
   ---
   
   Hej detta är min nya sida

Skapa nya kategorier

1. Skapa en katalog i src/content/docs.
2. Hitta en passande ikon för kategorin. Lista på tillgängliga ikoner går att hitta i Starlights dokumentation.
3. Lägg till din kategori i astro.config.mjs under starlightSidebarTopicsPlugin. Exempel:

   {
     id: "[id]"
     label: "[titel]",
     link: "/[katalog]/",
     icon: "[ikon]",
     items: [{ autogenerate: { directory: "[katalog]" } }],
   }