チートシート - GitHubスタイルのMarkdown - Markdown Toolbox

Markdown Toolbox

チートシート - GitHubスタイルのMarkdown

2023-12-12

GitHub flavored Markdown（GFM）は、標準のMarkdown構文を拡張し、GitHub特有のいくつかの追加機能を含みます。このチートシートは、GFMの重要な側面を網羅し、GitHubでのREADME、問題、およびその他のドキュメントを作成するのを容易にします。

拡張構文

タスクリスト

未完了のタスクには- [ ]、完了したタスクには- [x]を使用してタスクリストを作成します。
```
-   [x] 完了したタスク
-   [ ] 未完了のタスク
```

取り消し線

テキストに取り消し線を引くには、二重チルダ~~を使用します。
```
~~取り消し線~~
```

テーブル

ハイフン-とパイプ|を使用してテーブルを作成します。

| ヘッダー 1 | ヘッダー 2 |
| -------- | -------- |
| 行 1    | データ 1   |
| 行 2    | データ 2   |

フェンストコードブロック

三重バックティック（```）を使用し、構文ハイライト用の言語を指定します。

```javascript console.log("Hello, world!"); ```

ユーザーとチームをメンションする

@usernameを使用してユーザーまたはチームをメンションします。

問題とプルリクエストの参照

#を使用して問題やプルリクエストを参照します。

標準Markdown構文

見出し

#を使用してヘッダーを作成します。#の数が多いほど、ヘッダーは小さくなります。

テキストのフォーマット

太字: **太字**
イタリック: *イタリック*
太字とイタリック: ***太字 & イタリック***

リスト

順不同リスト: -、+、または*で始めます。
順序付きリスト: 数字の後に.を付けて始めます。

リンクと画像

リンク: [タイトル](URL)
画像: ![代替テキスト](URL)

ブロック引用

>を使用してブロック引用を作成します。

GitHubのMarkdownは、特に共同プロジェクトのコンテキストで、よりインタラクティブでダイナミックなドキュメントを可能にします。