README og Markdown
En README er en tekstfil som beskriver prosjektet ditt. Den heter som regel README.md og ligger i rotmappen til prosjektet. Når du legger prosjektet på GitHub, vises README-filen automatisk på forsiden.
README-filer skrives i Markdown, det er et enkelt tekstformat som lar deg lage overskrifter, lister, lenker og mer uten HTML.
Hva bør en README inneholde?
- Hva prosjektet gjør
- Hvilke teknologier som er brukt
- Hvordan man åpner eller kjører prosjektet
Start enkelt
Du trenger ikke skrive alt på en gang. Begynn med en tittel og en setning om hva prosjektet gjør, og utvid etter hvert.
Markdown-syntaks
Markdown baserer seg på HTML og de ulike delene kan ofte oversettes direkte.
Overskrifter
| Markdown | HTML | Resultat |
|---|---|---|
# |
<h1> |
Hovedoverskrift |
## |
<h2> |
Underoverskrift |
### |
<h3> |
Tredje nivå |
Obs!
Normalt bør du ikke ha mer enn én hovedoverskrift i et dokument.
Tekst
Lister
Lenker og bilder
Kodeblokker
Bruk tre backticks og språknavnet for å vise kode med syntaksutheving:
Eksempel på en README
Min nettside
En enkel nettside laget med HTML, CSS og JavaScript.
Teknologier
- HTML
- CSS
- JavaScript
Hvordan åpne
Åpne index.html i en nettleser.