Skip to main content
ドキュメントには頻繁に更新が加えられ、その都度公開されています。本ページの翻訳はまだ未完成な部分があることをご了承ください。最新の情報については、英語のドキュメンテーションをご参照ください。本ページの翻訳に問題がある場合はこちらまでご連絡ください。

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

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

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

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

また、@メンションIssue や PR の参照絵文字などの機能を使って、プルリクエストや Issue で他のユーザーとやりとりできます。

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

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

Enabling fixed-width fonts in the editor

You can enable a fixed-width font in every comment field on GitHub. Each character in a fixed-width, or monospace, font occupies the same horizontal space which can make it easier to edit advanced Markdown structures such as tables and code snippets.

Screenshot showing the GitHub comment field with fixed-width fonts enabled

  1. 任意のページの右上で、プロフィール画像をクリックし、続いてSettings(設定)をクリックしてください。

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

  2. In the left sidebar, click Appearance.

  3. Under "Markdown editor font preference", select Use a fixed-width (monospace) font when editing Markdown. Screenshot showing the GitHub comment field with fixed width fonts enabled

参考リンク