Sådan formateres kode i Markdown

Der er to måder at formatere kode i Markdown. Du kan enten bruge inline-kode ved at placere backticks (`) omkring dele af en linje, eller du kan bruge en kodeblok, som nogle gengivere anvender syntaksfremhævning på.

Integreret kode

Du kan bruge indbygget kodeformatering til at fremhæve en lille kommando eller et stykke syntaks inden for en linje, du skriver.

For eksempel vil du måske nævne JavaScript- Array.protoype.map()metoden. Ved at bruge inline-kodeformatering er det klart, at dette er et stykke kode. Du kan også bruge den til at illustrere en terminalkommando, som f.eks yarn install.

For at bruge indbygget kodeformatering skal du blot pakke den kode, du vil formatere, i backticks. På et standard amerikansk QWERTY-tastatur med layout kan dette findes til venstre for '1' og over Tab-tasten. Flere oplysninger om placeringen af ​​backtick på internationale tastaturer findes nedenfor.

F.eks. Gengives skrivning af 'Array.prototype.map ()' i markdown som Array.prototype.map().

Kodeblokke

For at skrive længere eller mere detaljerede kodestykker er det ofte bedre at placere dem inde i en kodeblok. Kodeblokke giver dig mulighed for at bruge flere linjer, og markdown gengiver det i sin egen boks og med skrifttype for kodetype.

For at opnå dette skal du starte din blok med en række på tre backticks. Dette signaliserer for markdown, at du opretter en kodeblok. Du bliver nødt til at afslutte med en anden linje med tre backticks. For eksempel:

`` ''

var add2 = funktion (antal) {

  retur nummer + 2;

}

`` ''

vises i markdown som:

var add2 = function(number) { return number + 2; }

Syntaksfremhævning

Selvom det ikke understøttes indbygget af markdown, understøtter mange markdown-motorer, inklusive den der bruges af GitHub, syntaksfremhævning. Dette betyder, at ved at fortælle markdown, hvilket sprog du bruger inde i kodeblokken, tilføjer det farver som en IDE ville.

Du kan gøre dette ved at tilføje navnet på sproget på den samme linje som dine tre bageste kryds. I eksemplet ovenfor, hvis i stedet for at den første linje er `` '' du kunne skrive `` js, vil JavaScript-fremhævning blive anvendt på blokken.

var add2 = function(number) { return number + 2; }

Syntaksfremhævning kan dog anvendes på mere end bare JavaScript. Du kan bruge '' html:

Hello World

`` rubin:

"Hello World".split('').each do |letter| puts letter end

eller `` python:

a, b = 0, 1 while b < 10: print(b) a, b = a, a + b

Bare husk, ikke alle markdown-motorer anvender syntaksfremhævning.

Backticks på internationale tastaturer

Placeringen af ​​backtick-tasten kan være forskellig på forskellige tastaturer, og hvis du ikke bruger et amerikansk QWERTY-tastatur, kan det være vanskeligt at finde det. Denne nyttige guide viser nogle af måderne til at finde din backtick-nøgle, som vi har samlet her nedenfor:

QWERTY og QWERTZ:

AZERTY: