Skip to main content

Enterprise Server 3.15 は、現在リリース候補として使用できます。

GitHub 上での執筆とフォーマットについて

GitHubは、GitHub Flavored Markdown と呼ばれるテキストフォーマットの構文を、いくつかのユニークな執筆用の機能と組み合わせています。

この機能を使用できるユーザーについて

Markdown can be used in the GitHub web interface.

Markdown は、プレーンテキストを書式設定するための読みやすく書きやすい言語です。

サイトで文章とコードをフォーマットするのに使われる GitHubFlavored Markdown を作り出すために、弊社ではカスタムの機能をいくつか追加しました。

また、pull request や issue では、@-mentions、issue と PR の参照、絵文字などの機能を使って他のユーザーとやり取りすることもできます。 詳しくは、「基本的な書き方とフォーマットの構文」を参照してください。

テキストフォーマット用のツールバー

GitHub Enterprise Serverのすべてのコメントフィールドには、テキストフォーマット用のツール バーが含まれており、Markdown の構文を学ばなくてもテキストをフォーマットできます。 太字や斜体といったスタイルなどの Markdown の書式、ヘッダー、リンク、リストの作成といったことに加えて、このツールバーには @-mentions、タスクリスト、issue と pull request へのリンクといった GitHub Enterprise Server 固有の機能があります。

エディターで固定幅フォントを有効にする

GitHub Enterprise Server のすべてのコメント フィールドで固定幅フォントを有効にすることができます。 固定幅のフォント (等幅フォント) の各文字は、同じ横幅のスペースを占有しています。 これにより、テーブルやコード スニペットなどの高度な Markdown 構造の編集を容易にすることができます。

2 つの Git コマンドを列挙した Markdown テーブルのサンプルを示す GitHub コメントのスクリーンショット。 テーブル内の文字はすべて同じ表示幅です。

  1. GitHub で、任意のページの右上隅にある自分のプロフィール写真をクリックしてから、 [設定] をクリックします。
  2. 左側のサイドバーで、[ 外観] をクリックします。
  3. [Markdown editor font preference](Markdown エディターのフォント設定) で [Use a fixed-width (monospace) font when editing Markdown](Markdown の編集時に固定幅 (等幅) フォントを使用する) を選びます。
    Markdown 基本設定の GitHub ユーザー設定のスクリーンショット。 Markdown で固定幅フォントを使うチェック ボックスがオンになり、濃いオレンジ色の枠線で囲まれています。

参考資料