Skip to main content

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

GitHubでの書き込みと書式設定について

GitHubでは、GitHub Flavored Markdown と呼ばれるテキストを書式設定するための構文と、いくつかの固有の書き込み機能を組み合わせています。

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

Markdown は、GitHub Web インターフェイスで使用できます。

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

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

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

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

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

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

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

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

  1. GitHub の任意のページの右上隅にあるプロフィール写真をクリックし、[ Settings] をクリックします。1. 左側のサイドバーの [Appearance] をクリックします。

  2. [Markdown editor font preference](Markdown エディターのフォント設定) で [Use a fixed-width (monospace) font when editing Markdown](Markdown の編集時に固定幅 (等幅) フォントを使用する) を選びます。

           ![Markdown 基本設定の GitHub ユーザー設定のスクリーンショット。 Markdown で固定幅フォントを使うチェック ボックスがオンになり、濃いオレンジ色の枠線で囲まれています。](/assets/images/help/writing/enable-fixed-width.png)
    

参考資料

  •         [GitHub Flavored Markdown の仕様](https://github.github.com/gfm/)
    
  •         [AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)
    
  •         [AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting)
    
  •         [AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github)