Markdownでコードをフォーマットする方法

Markdownでコードをフォーマットする方法は2つあります。行の一部をバッククォート( `)で囲むことにより、インラインコードを使用するか、一部のレンダラーが構文の強調表示を適用するコードブロックを使用することができます。

インラインコード

インラインコードフォーマットを使用して、記述している行内の小さなコマンドまたは構文の一部を強調できます。

たとえば、JavaScriptのArray.protoype.map()メソッドについて言及したい場合があります。インラインコードフォーマットを使用することにより、これがコードの一部であることは明らかです。また、のようなターミナルコマンドを説明するために使用することもできますyarn install

インラインコードフォーマットを使用するには、フォーマットするコードをバッククォートでラップするだけです。標準のUSレイアウトQWERTYキーボードでは、これは「1」の左側、Tabキーの上にあります。国際キーボードのバッククォートの位置の詳細については、以下を参照してください。

たとえば、マークダウンで `Array.prototype.map()`を書き込むと、としてレンダリングされArray.prototype.map()ます。

コードブロック

より長く、より詳細なコードスニペットを作成するには、コードブロック内に配置する方がよい場合がよくあります。コードブロックを使用すると、複数の行を使用できます。マークダウンを使用すると、独自のボックス内にコードタイプのフォントでレンダリングされます。

これを実現するには、3つのバッククォートの行でブロックを開始します。これは、コードブロックを作成していることをマークダウンに通知します。3つのバックティックの別の行で終了する必要があります。例えば:

`` `

var add2 = function(number){

  戻り値+2;

}

`` `

マークダウンで次のようにレンダリングされます:

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

構文の強調表示

マークダウンではネイティブにサポートされていませんが、GitHubで使用されているものを含め、多くのマークダウンエンジンは構文の強調表示をサポートします。これは、コードブロック内で使用している言語をマークダウンに伝えることで、IDEのように色を追加することを意味します。

これを行うには、最初の3つのバックティックと同じ行に言語の名前を追加します。上記の例では、最初の行が「」ではなく「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

すべてのマークダウンエンジンが構文の強調表示を適用するわけではないことを覚えておいてください。

国際キーボードのバックティック

バッククォートキーの位置はキーボードによって異なる場合があり、USレイアウトのQWERTYキーボードを使用していない場合は、見つけるのが難しい場合があります。この役立つガイドには、以下に収集したバッククォートキーを見つける方法のいくつかがリストされています。

QWERTYおよびQWERTZ:

AZERTY: