So formatieren Sie Code in Markdown

Es gibt zwei Möglichkeiten, Code in Markdown zu formatieren. Sie können entweder Inline-Code verwenden, indem Sie Backticks (`) um Teile einer Zeile setzen, oder Sie können einen Codeblock verwenden, auf den einige Renderer Syntaxhervorhebungen anwenden.

Inline-Code

Sie können die Inline-Code-Formatierung verwenden, um einen kleinen Befehl oder eine Syntax in einer Zeile hervorzuheben, die Sie schreiben.

Beispielsweise möchten Sie möglicherweise die JavaScript- Array.protoype.map()Methode erwähnen . Durch die Verwendung der Inline-Code-Formatierung wird deutlich, dass dies ein Teil des Codes ist. Sie können es auch verwenden, um einen Terminalbefehl zu veranschaulichen, wie z yarn install.

Um die Inline-Code-Formatierung zu verwenden, verpacken Sie einfach den Code, den Sie formatieren möchten, in Backticks. Auf einer Standard-QWERTZ-Tastatur mit US-Layout befindet sich diese links von '1' und über der Tabulatortaste. Weitere Informationen zur Position des Backticks auf internationalen Tastaturen finden Sie unten.

Wenn Sie beispielsweise "Array.prototype.map ()" in Markdown schreiben, wird dies als gerendert Array.prototype.map().

Codeblöcke

Um längere oder detailliertere Codeausschnitte zu schreiben, ist es oft besser, sie in einem Codeblock zu platzieren. Mit Codeblöcken können Sie mehrere Zeilen verwenden. Durch Markdown wird diese in einem eigenen Feld und mit Codetyp-Schriftart gerendert.

Um dies zu erreichen, starten Sie Ihren Block mit einer Reihe von drei Backticks. Dies signalisiert dem Markdown, dass Sie einen Codeblock erstellen. Sie müssen mit einer weiteren Zeile mit drei Backticks abschließen. Zum Beispiel:

`` `

var add2 = Funktion (Nummer) {

  Rückgabe Nummer + 2;

}}

`` `

wird im Abschlag gerendert als:

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

Satzstellung markieren

Obwohl dies von Markdown nicht nativ unterstützt wird, unterstützen viele Markdown-Engines, einschließlich der von GitHub verwendeten, die Syntaxhervorhebung. Dies bedeutet, dass durch Markieren der Markierung, welche Sprache Sie im Codeblock verwenden, Farben hinzugefügt werden, wie dies bei einer IDE der Fall wäre.

Sie können dies tun, indem Sie den Namen der Sprache in derselben Zeile wie Ihre ersten drei Back Ticks hinzufügen. Wenn Sie im obigen Beispiel anstelle der ersten Zeile `` `js` `` js schreiben könnten, wird die JavaScript-Hervorhebung auf den Block angewendet.

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

Die Syntaxhervorhebung kann jedoch nicht nur auf JavaScript angewendet werden. Sie können `` `html verwenden:

Hello World

`` `rubin:

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

oder `` `Python:

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

Denken Sie daran, dass nicht alle Markdown-Engines Syntaxhervorhebungen anwenden.

Backticks auf internationalen Tastaturen

Die Position der Backtick-Taste kann auf verschiedenen Tastaturen unterschiedlich sein. Wenn Sie keine QWERTZ-Tastatur mit US-Layout verwenden, ist die Suche möglicherweise schwierig. Diese hilfreiche Anleitung listet einige Möglichkeiten auf, wie Sie Ihren Backtick-Schlüssel finden können, den wir hier unten gesammelt haben:

QWERTY und QWERTZ:

AZERTY: