Skip to main content
ドキュメントへの更新が頻繁に発行されており、このページの翻訳はまだ行われている場合があります。 最新の情報については、「英語のドキュメント」を参照してください。

このバージョンの GitHub Enterprise はこの日付をもって終了となりました: 2023-03-15. 重大なセキュリティの問題に対してであっても、パッチリリースは作成されません。 パフォーマンスの向上、セキュリティの向上、新機能の向上を図るために、最新バージョンの GitHub Enterprise にアップグレードします。 アップグレードに関するヘルプについては、GitHub Enterprise サポートにお問い合わせください

コードブロックの作成と強調表示

コードのサンプルをコードブロックにし、構文を強調表示して共有しましょう。

フェンスされたコード ブロック

三連バッククォート ``` をコード ブロック前後に入力すると、フェンスされたコード ブロックを作成できます。 ソースコードを読みやすくするために、コードブロックの前後に空の行を入れることをお勧めします。

```
function test() {
  console.log("notice the blank line before this function?");
}
```

3 重のバッククォートによってコード ブロックが未加工の形式でレンダリングされることを示す、GitHub Markdown をレンダリングしたスクリーンショット。 ブロックは "function test() {" で始まっています。

参考: リスト内でフォーマットを保持するために、フェンスされていないコード ブロックをスペース 8 つでインデントします。

フェンスされたコード ブロックの中に 3 重のバッククォートを表示するには、4 重のバッククォートで囲みます。

````
```
Look! You can see my backticks.
```
````

4 重のバッククォートが、コード ブロックを囲む 3 重のバッククォートをそのまま表示することを示す、GitHub Markdown をレンダリングしたスクリーンショット。 このブロックには、「ほら! バッククォートが見えますよ」と書かれています。

コード スニペットとテーブルを頻繁に編集する場合は、GitHub Enterprise Server のすべてのコメント フィールドで固定幅フォントを有効にするとメリットが得られる可能性があります。 詳しくは、「GitHub 上での執筆とフォーマットについて」を参照してください。

構文の強調表示

言語識別子を追加して、コードブロックの構文を強調表示することができます。

構文の強調表示は、ソース コードの色やスタイルを変えて読みやすくするものです。

たとえば、Ruby コードの構文を強調表示するには:

```ruby
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
```

これは、コード ブロックを構文強調表示で表示します。

GitHub に表示された 3 行の Ruby コードのスクリーンショット。 コードの要素が紫、青、赤の文字で表示され、より視覚的に読み取りやすくなっています。

Linguist を使って言語検出を行い、サードパーティの文法を選んで構文の強調表示を行います。 どのキーワードが有効かは、languages YAML ファイルで確認できます。

参考資料