Markdown Guide

Hva er Markdown?

Markdown er et lett markeringsspråk som du kan bruke til å legge til formateringselementer i klartekstdokumenter. Det lar deg lage formatert tekst ved hjelp av en enkel, lett-å-lese syntaks som kan konverteres til HTML og andre formater.

Tenk på Markdown som en måte å skrive formaterte dokumenter uten å trenge komplekse tekstbehandlere. Du legger ganske enkelt til spesielle tegn i ren tekst for å indikere formatering som fet, kursiv, eller kode.

Hvorfor bruke Markdown?

Markdown er utrolig enkel og lett å lære. Du kan mestre det grunnleggende på bare 10 minutter. Formateringsymbolene er intuitive - stjerner for utheving, hash for overskrifter. Du bare skriver og legger til enkle symboler for å formatere teksten din.

Markdown fungerer på alle plattformer og i alle teksteditorer. Siden filene er ren tekst, vil de alltid være lesbare, selv tiår fra nå. Filene er lette og lastes raskt.

Markdown har bred støtte på tvers av plattformer. GitHub, Reddit, Discord og Slack bruker alle Markdown. Populære apper som Obsidian, Notion og VS Code støtter det innebygd. Dette gjør det perfekt for dokumentasjon, notater og webinnhold.

Markdown fungerer perfekt med versjonskontrollsystemer som Git. Du kan fokusere på innhold uten formateringsdistraksjoner. Teamsamarbeid er enklere fordi alle kan redigere filer uten spesiell programvare.

Markdowns utviklingshistorie

Begynnelsen: Vanilla Markdown (2004)

Markdown ble opprinnelig skapt av John Gruber i 2004, med betydelig bidrag fra Aaron Swartz. Gruber designet det som en enkel måte å skrive på ved hjelp av et lett-å-lese og lett-å-skrive klartekstformat som kunne konverteres til strukturelt gyldig HTML. Dette er "kjernen" som John Gruber opprinnelig designet og implementerte, som inneholder den mest grunnleggende formateringssyntaksen - det vi kaller "grunnleggende vanilla-smaken".

Grunnleggende syntaks (Vanilla Markdown inkluderer):

  • •
    Overskrifter: Bruk # symbol (# Overskrift)

  • •
    Utheving:

  • •
    Kursiv: Bruk * eller _ for å omgi tekst (*kursiv* eller _kursiv_)
  • •
    Fet: Bruk ** eller __ for å omgi tekst (**fet** eller __fet__)

  • •
    Lister:

  • •
    Unummererte lister: Bruk *, -, eller + (- element)
  • •
    Nummererte lister: Bruk tall med punktum (1. element)
  • •
    Lenker: Bruk [lenketekst](lenkeadresse)
  • •
    Bilder: Bruk ![bildebeskrivelse](bildeadresse)

  • •
    Kodeblokker: Innrykk med mellomrom (vanligvis 4 mellomrom eller 1 Tab)

  • •
    Blokksitater: Bruk > symbol (> Dette er et sitat)
  • •
    Horisontale linjer: Bruk --- eller ***

Problemet: Inkonsistente implementasjoner

Imidlertid manglet Vanilla Markdown en streng, formell spesifikasjon. Dette førte til inkonsistent oppførsel på tvers av forskjellige Markdown-parsere når de håndterte edge cases.

Mellomromsbehandling: For eksempel, i listeelementer, hvor mange mellomrom med innrykk teller som en underliste? Er det 2 mellomrom, 3 mellomrom eller 4 mellomrom? Forskjellige parsere kan ha forskjellige vurderinger.

Linjeskiftbehandling: I visse situasjoner, bør et vanlig linjeskift(\n) parses som en <br> (linjeskift) tag, eller bør det bare behandles som et mellomrom i teksten? Dette kan også variere avhengig av parseren.

HTML blandet bruk: Markdown tillater innebygd HTML. Imidlertid, i noen komplekse HTML-strukturer, presenterer hvordan Markdown-parsere håndterer Markdown-syntaks innenfor dem også tvetydige områder.

Løsningen: CommonMark (2014)

I september 2014 ble CommonMark introdusert for å løse disse inkonsistensproblemene. Ledet av John MacFarlane, gir det en streng spesifikasjon for Markdown.

CommonMark gir en presis spesifikasjon hvor hvert edge case er klart definert. Det inkluderer en omfattende testpakke med over 600 testtilfeller for å sikre konsistens på tvers av implementasjoner. Spesifikasjonen gir en referanseimplementasjon som fungerer som en standard for andre parsere å følge. Den opprettholder bakoverkompatibilitet med de fleste eksisterende Markdown-dokumenter samtidig som den sikrer utvetydig parsing hvor samme input alltid produserer samme output på tvers av alle kompatible parsere.

Utvidede smaker og tilleggsfunksjoner

Ettersom brukere hadde forskjellige behov, dukket det opp forskjellige utvidede smaker av Markdown for å møte spesifikke krav.

GitHub Flavored Markdown (GFM) Tilleggssyntaks:

  • •
    Tabeller: Bruk pipe-syntaks for å lage tabeller
  | Overskrift 1 | Overskrift 2 | Overskrift 3 |
  |----------|----------|----------|
  | Celle 1   | Celle 2   | Celle 3   |
  | Celle 4   | Celle 5   | Celle 6   |
  • •
    Gjennomstreking: Bruk ~~ for å omgi tekst (~~slettet tekst~~)

  • •
    Oppgavelister: Lag interaktive avkrysningsbokser

  - [x] Fullført oppgave
  - [ ] Ufullstendig oppgave
  • •
    Avgrenset kodeblokker: Bruk tre backticks med språkspesifikasjon
  ```javascript
  function hello() {
    console.log("Hello World!");
  }
  ```
  • •
    Automatisk lenking: URLer og e-postadresser blir automatisk klikkbare

Andre populære utvidelser:

  • •
    Fotnoter: Bruk [^1] syntaks for akademisk skriving
  Dette er en setning med en fotnote[^1].
  [^1]: Dette er innholdet i fotnoten.

Resultat: Dette er en setning med en fotnote¹.

  • •
    Matematiske uttrykk: Bruk $E=mc^2$ for vitenskapelige dokumenter
  • •
    Emoji-snarveier: Bruk :smile: blir 😊

  • •
    Definisjonslister: For ordlister og teknisk dokumentasjon

  Term 1
  : Definisjon for term 1
  
  Term 2
  : Definisjon for term 2
  : En annen definisjon for term 2

Resultat: Lager formaterte lister med uthevede termer og innrykkede definisjoner

Hvordan fungerer det?

Markdown følger en enkel tre-trinns arbeidsflyt:

Trinn 1: Lag en Markdown-fil

Først lager du en klartekstfil med en .md eller .markdown utvidelse ved hjelp av en hvilken som helst teksteditor. Du skriver innholdet ditt ved hjelp av enkle formateringssymboler:

Trinn 2: Behandle med Markdown-verktøy

Din .md fil blir deretter behandlet av Markdown-konverteringsverktøy eller prosessorer. Disse verktøyene leser Markdown-filen din og konverterer den til ønsket utdataformat.

Trinn 3: Utdata til forskjellige formater

Markdown-prosessoren kan konvertere filen din til flere formater:

For webvisning:

  • •
    Konverterer til HTML for nettsteder, blogger og webapplikasjoner

  • •
    Viser formatert innhold i nettlesere med riktig styling

For dokumenter:

  • •
    Konverterer til PDF for utskrivbare dokumenter og rapporter

  • •
    Genererer Word-dokumenter (.docx) for kontorbruk
  • •
    Lager LaTeX for akademiske papirer og publikasjoner

For publisering:

  • •
    Genererer e-bøker (EPUB-format)

  • •
    Lager presentasjonsbilder
  • •
    Produserer dokumentasjonsnettsteder

Denne arbeidsflyten betyr at du skriver én gang i Markdown, og deretter bruker forskjellige verktøy for å konvertere innholdet ditt til hvilket som helst format du trenger - enten det er å vise på et nettsted, skrive ut som PDF eller dele som et dokument.

Tilleggsressurser

Essensiell dokumentasjon

  • •
    John Grubers Markdown-dokumentasjon :Den opprinnelige guiden skrevet av skaperen av Markdown. Essensiell lesning for å forstå filosofien og grunnleggende syntaks.

  • •
    Wikipedia - Markdown :Omfattende oversikt over Markdowns historie, variasjoner og tekniske detaljer.

  • •
    Markdown Guide :En omfattende, nybegynnervennlig guide med eksempler og beste praksis for alle ferdighetsnivåer.