Как да форматирам код в Markdown

Има два начина за форматиране на код в Markdown. Можете да използвате вграден код, като поставите обратни отметки (`) около части от ред, или можете да използвате кодов блок, към който някои визуализатори ще приложат подчертаване на синтаксиса.

Вграден код

Можете да използвате вградено форматиране на код, за да подчертаете малка команда или част от синтаксиса в реда, който пишете.

Например, може да пожелаете да споменете Array.protoype.map()метода на JavaScript . Чрез използване на вградено форматиране на код става ясно, че това е част от кода. Можете също да го използвате, за да илюстрирате терминална команда, като yarn install.

За да използвате вградено форматиране на код, просто увийте кода, който искате да форматирате, в обратни отметки. На стандартна QWERTY клавиатура за американско оформление това може да се намери вляво от „1“ и над клавиша Tab. Повече информация за местоположението на задния удар на международни клавиатури е предоставена по-долу.

Например, записването на "Array.prototype.map ()" в маркирането ще се превърне в Array.prototype.map().

Кодови блокове

За да пишете по-дълги или по-подробни фрагменти от код, често е по-добре да ги поставите в кодов блок. Кодовите блокове ви позволяват да използвате множество редове и маркирането ще го направи в собственото му поле и с шрифт от кодов тип.

За да постигнете това, започнете блока си с ред от три обратни връзки. Това сигнализира за маркиране, че създавате кодов блок. Ще трябва да завършите с още един ред от три обратни връзки. Например:

„„

var add2 = функция (число) {

  номер за връщане + 2;

}

„„

ще се покаже в намаление като:

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

Подчертаване на синтаксиса

Макар да не се поддържат отначало чрез маркиране, много двигатели за маркиране, включително този, използван от GitHub, ще поддържат подчертаване на синтаксиса. Това означава, че като каже маркиране какъв език използвате в блока на кода, той ще добави цветове като IDE.

Можете да направите това, като добавите името на езика на същия ред като вашите три отварящи се отметки. В горния пример, ако вместо първият ред да бъде „можете да напишете„ js, тогава към блока ще бъде приложено подчертаването на JavaScript.

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

Открояването на синтаксиса обаче може да се приложи не само към JavaScript. Можете да използвате „html:

Hello World

„рубин:

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

или „python:

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

Само не забравяйте, не всички двигатели за маркиране ще прилагат подчертаване на синтаксиса.

Обратни връзки на международни клавиатури

Местоположението на клавиша за обратно връщане може да е различно при различните клавиатури и ако не използвате клавиатура QWERTY с американско оформление, може да е трудно да се намери. Това полезно ръководство изброява някои от начините за намиране на вашия ключ за обратна връзка, които сме събрали тук по-долу:

QWERTY и QWERTZ:

AZERTY: