Skip to main content

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

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

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

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

また、pull request や issue では、@mentionsissue と PR の参照絵文字などの機能を使って他のユーザーとやり取りすることもできます。

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

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

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

GitHub Enterprise Cloud のすべてのコメント フィールドで固定幅フォントを有効にすることができます。 固定幅 (等幅) フォントの各文字は同じ水平方向の間隔を占めるため、テーブルやコード スニペットなどの高度な Markdown 構造の編集が簡単にできます。

固定幅フォントを有効にした GitHub Enterprise Cloud のコメント フィールドを示すスクリーンショット

  1. 任意のページで、右上隅にあるプロファイルの画像をクリックし、次に[設定]をクリックします。

    ユーザバーの [Settings(設定)] アイコン

  2. In the left sidebar, click Appearance.

  3. [Markdown editor font preference](Markdown エディターのフォント設定) で [Use a fixed-width (monospace) font when editing Markdown](Markdown の編集時に固定幅 (等幅) フォントを使用する) を選びます。 GitHub Enterprise Cloud のコメント フィールドで固定幅フォントを有効にしているスクリーンショット

参考資料