Gå til indholdet

Velkommen til Eksempelprojektet

Dette projekt er et eksempel på, hvordan man kan strukturere dokumentation og logbog i forbindelse med opgaver og afleveringer på uddannelsen.

Dokumentationen er skrevet i Markdown, et simpelt og letlæseligt tekstformat, der gør det nemt at lave overskrifter, lister, kodeblokke og meget mere – alt sammen i almindelige tekstfiler.

Den færdige dokumentation bliver automatisk genereret som en hjemmeside ved hjælp af MkDocs og udgivet via GitLab Pages.

🧭 Hvad finder du her?

Projektet er struktureret sådan, at du kan dokumentere:

  • Din logbog – fx daglige noter, refleksioner og beslutninger
  • Opgaveløsninger – fx beskrivelse af arbejdsgang, kode, test og resultater
  • Billeder og skærmbilleder – fx af prototyper, terminal, design, mv.
  • Links til eksterne ressourcer

✍️ Eksempler på Markdown-syntaks

Overskrifter

Dette er en H1

Dette er en H2

Dette er en H3

# Dette er en H1
## Dette er en H2
### Dette er en H3

from scapy.all import *

for i in range(9):
    print(i)

Note

test af call-out / Admonitions

Nu med en titel/overskrift!

test af call-out / Admonitions

Nu med overskrift og skjult

Test af call-out boks som gerne skulle være "usynlig"