Hogyan formázzuk a kódot a Markdown-ban

A Markdownban kétféleképpen lehet formázni a kódot. Vagy használhat inline kódot, ha a backticks (`) karaktereket a sor részeire helyezi, vagy használhat egy kódblokkot, amelyre egyes megjelenítők szintaxis kiemeléseket alkalmaznak.

Inline kód

Használhatja az inline kódformázást, hogy kiemeljen egy kis parancsot vagy szintaxis darabot az írott soron belül.

Például megemlítheti a JavaScript Array.protoype.map()módszerét. Az inline kódformázás használatával egyértelmű, hogy ez egy darab kód. Használhatja egy terminálparancs illusztrálására is yarn install.

Az inline kódformázás használatához egyszerűen csomagolja be a formázni kívánt kódot a backticks-be. A szokásos amerikai elrendezésű QWERTY billentyűzeten ez az '1' bal oldalán és a Tab billentyű felett található. Az alábbiakban további információk találhatók a háttér billentyűzet helyéről a nemzetközi billentyűzeteken.

Például az írás `Array.prototype.map ()` a árleszállítás lehetővé teszi majd, mint Array.prototype.map().

Kód blokkok

Hosszabb vagy részletesebb kódrészletek írásához gyakran jobb, ha egy kódblokkba helyezi őket. A kódblokkok lehetővé teszik több sor használatát, és a jelöléssel a saját dobozában és kódtípusú betűtípussal jelenik meg.

Ennek eléréséhez indítsa el a blokkot három backtick sorral. Ez jelzi a jelöléssel, hogy kódblokkot hoz létre. Egy másik három backtick sorral kell befejeznie. Például:

"

var add2 = függvény (szám) {

  visszatérési szám + 2;

}

"

a leírásban a következőképpen jelenik meg:

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

Szintaxis kiemelés

Bár a markdown nem támogatja natív módon, sok markdown motor, beleértve a GitHub által használt motort is, támogatja a szintaxis kiemelését. Ez azt jelenti, hogy a kódblokk belsejében megadva, hogy milyen nyelvet használ, olyan színeket ad hozzá, mint egy IDE.

Ezt úgy teheti meg, hogy a nyelv nevét ugyanazon a soron adja meg, mint a nyitó három hátsó kullancs. A fenti példában, ha az első sor helyett "" js-t írhatna, akkor a blokkra JavaScript kiemelés kerül alkalmazásra.

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

A szintaxis kiemelése nemcsak JavaScriptre alkalmazható. Használhatja a "html:

Hello World

"rubin:

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

vagy "" python:

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

Ne feledje, hogy nem minden markdown motor alkalmazza a szintaxis kiemelését.

Backticks a nemzetközi billentyűzeteken

A backtick kulcs helye a különböző billentyűzeteken eltérő lehet, és ha nem amerikai elrendezésű QWERTY billentyűzetet használ, akkor bonyolult megtalálni. Ez a hasznos útmutató felsorolja a backtick kulcs megtalálásának néhány módját, amelyeket itt gyűjtöttünk össze:

QWERTY és QWERTZ:

AZERTY: