README.md 660 Bytes
Newer Older
Iver Småge men bærbar's avatar
Iver Småge men bærbar committed
1
# Docs
GitLab's avatar
GitLab committed
2

Iver Småge men bærbar's avatar
Iver Småge men bærbar committed
3
Dette er repoet som holder dokumentasjonen til faget. Det er satt opp gitlab ci, så alle endringer på main branch reflekteres til den offisielle dokumentasjonen på push eller godkjent pull request.
GitLab's avatar
GitLab committed
4

Iver Karlsbakk Småge's avatar
Iver Karlsbakk Småge committed
5
6
Nettsiden finnes på <https://tdt4102.pages.stud.idi.ntnu.no/documentation/>

Iver Småge men bærbar's avatar
Iver Småge men bærbar committed
7
## Hvordan kjøre lokalt
GitLab's avatar
GitLab committed
8

Iver Småge men bærbar's avatar
Iver Småge men bærbar committed
9
10
11
`pip install -r requirements.txt` - Installer de nødvendige bibliotekene
`mkdocs serve` - Start en lokal server med live-reloading
`mkdocs build` - Kompiler filene lokalt
Iver Karlsbakk Småge's avatar
Iver Karlsbakk Småge committed
12
13

Dersom python scripts ikke er på path kan du bruke `python -m mkdocs`, men jeg anbefaler på det sterkeste å legge de til på path. Pip gir warnings om dette på install.