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

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

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

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

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

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

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

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

1. GitHub で、任意のページの右上隅にある自分のプロフィール写真をクリックしてから、 [設定] をクリックします。
2. 左側のサイドバーで、[ 外観] をクリックします。
3. [Markdown editor font preference](Markdown エディターのフォント設定) で [Use a fixed-width (monospace) font when editing Markdown](Markdown の編集時に固定幅 (等幅) フォントを使用する) を選びます。
   

参考資料

• GitHub Flavored Markdown の仕様
• 基本的な書き方とフォーマットの構文
• 高度なフォーマットを使用して作業する
• GitHub 上での書き込みに関するクイックスタート