Markdownチートシート
AI作成データ
このコンテンツのデータはAIが公式資料や辞書を参照して作成しました。正確さを心がけていますが、誤りが含まれる可能性があります。Markdownの書き方を網羅したチートシート。見出し・リスト・リンク・画像・テーブル・コードブロック・引用など基本構文から応用まで実例付きで解説。
Markdown記法を構文と実例で網羅。書き方に迷ったらすぐ引ける
こんなときに使えます
見出し・リスト・テーブル・コードブロックなど基本から応用まで網羅
Markdownの書き方を網羅したチートシート。見出し・リスト・リンク・画像・テーブル・コードブロック・引用など基本構文から応用まで実例付きで解説。
Markdown記法を構文と実例で網羅。書き方に迷ったらすぐ引ける
こんなときに使えます
見出し・リスト・テーブル・コードブロックなど基本から応用まで網羅
# の数で見出しレベル(h1〜h6)を指定します。# の後にはスペースを入れてください。
# 見出し1(h1)
## 見出し2(h2)
### 見出し3(h3)
#### 見出し4(h4)
##### 見出し5(h5)
###### 見出し6(h6)見出し1
=======
見出し2
-------テキストに太字、斜体、取り消し線、インラインコードなどの装飾を適用できます。
**太字テキスト**
__太字テキスト__*斜体テキスト*
_斜体テキスト_***太字かつ斜体***
___太字かつ斜体___~~取り消し線テキスト~~`console.log("Hello")` のようにバッククォートで囲みます。H<sub>2</sub>O は水の化学式です。
E = mc<sup>2</sup>| 記法 | 表示結果 |
|---|---|
**太字** | 太字 |
*斜体* | 斜体 |
~~取り消し~~ | |
`コード` | コード |
***太字斜体*** | 太字斜体 |
-、*、+ のいずれかで順序なしリストを作成できます。
- りんご
- バナナ
- みかん
* りんご
* バナナ
* みかん数字とピリオドで順序付きリストを作成します。番号は自動で振り直されます。
1. 最初の項目
2. 次の項目
3. 最後の項目
1. すべて1で書いても
1. 自動的に番号が
1. 振られますインデント(スペース2〜4個)でリストをネストできます。
- 果物
- りんご
- ふじ
- 紅玉
- バナナ
- 野菜
- にんじん
- たまねぎ- [ ] で未完了、- [x] で完了のタスクリストを作成できます。
- [x] 完了したタスク
- [ ] 未完了のタスク
- [ ] もう一つの未完了タスク[リンクテキスト](https://example.com)
[タイトル付きリンク](https://example.com "リンクのタイトル")リンクURLを文書の別の場所でまとめて定義できます。
[Google][1]と[Yahoo][2]を参照してください。
[1]: https://google.com "Googleのサイト"
[2]: https://yahoo.co.jp "Yahooのサイト"<https://example.com>
<user@example.com>
[](https://example.com)| 種類 | 記法 |
|---|---|
| リンク | [テキスト](URL) |
| 画像 |  |
| 画像+リンク | [](リンクURL) |
| 参照リンク | [テキスト][id] |
| 自動リンク | <URL> |
バッククォート(`)でテキストを囲みます。
変数 `count` の値を確認してください。二重バッククォートを使います。
`` ここに `バッククォート` を含められます ``バッククォート3つ(```)またはチルダ3つ(~~~)で囲みます。開始行に言語名を指定するとシンタックスハイライトが有効になります。
```javascript
function hello() {
console.log("Hello, World!");
}
``````python
def hello():
print("Hello, World!")
```行頭にスペース4つまたはタブ1つを置くとコードブロックになります。
通常のテキスト
// これはコードブロックです
const x = 1;
console.log(x);パイプ(|)とハイフン(-)でテーブルを作成します。2行目のハイフンが列の区切りになります。
| 名前 | 年齢 | 職業 |
| ------ | ---- | ---------- |
| 田中 | 30 | エンジニア |
| 佐藤 | 25 | デザイナー |
| 鈴木 | 35 | マネージャー |コロン(:)の位置で左寄せ・中央揃え・右寄せを指定します。
| 左寄せ | 中央揃え | 右寄せ |
| :--------- | :--------: | ---------: |
| left | center | right |
| テキスト | テキスト | テキスト || 記法 | 配置 |
|---|---|
:--- | 左寄せ(デフォルト) |
:---: | 中央揃え |
---: | 右寄せ |
行頭に > を付けて引用ブロックを作成します。
> これは引用文です。
> 複数行にまたがることができます。> 第一レベルの引用
> > 第二レベルの引用
> > > 第三レベルの引用引用ブロック内でも他のMarkdown記法を使えます。
> ## 引用内の見出し
>
> - リスト項目1
> - リスト項目2
>
> **太字**や*斜体*も使えます。
>
> `コード`も書けます。以下のいずれかを行に単独で書くと水平線(<hr>)が挿入されます。3つ以上のハイフン、アスタリスク、アンダースコアを使います。
---
***
___
- - -
* * *--- は見出しのSetext記法と間違えやすいので、前後に空行を入れるのがおすすめです。MarkdownファイルにはHTMLタグを直接書くことができます。Markdownで表現できない装飾やレイアウトに便利です。
<div style="color: red;">赤いテキスト</div>
<details>
<summary>クリックで展開</summary>
ここに隠れたコンテンツを書きます。
Markdownの記法も使えます。
- リスト項目1
- リスト項目2
</details>行末にスペース2つで改行
または<br>タグを使います。Markdown標準では画像サイズを指定できませんが、HTMLなら可能です。
<img src="image.png" alt="説明" width="300" height="200"><div align="center">中央揃えのテキスト</div>
<p align="right">右寄せのテキスト</p><details>内の空行の後にMarkdownが有効になります。GitHub Flavored Markdown(GFM)は標準のMarkdownにいくつかの便利な拡張を追加しています。
- [x] 実装完了
- [x] テスト完了
- [ ] レビュー待ち
- [ ] デプロイコロンで囲んだショートコードで絵文字を挿入できます。
:smile: :+1: :heart: :rocket: :warning:
:tada: :bug: :memo: :fire: :star:| ショートコード | 絵文字 | 用途 |
|---|---|---|
:bug: | 🐛 | バグ修正 |
:sparkles: | ✨ | 新機能 |
:memo: | 📝 | ドキュメント |
:rocket: | 🚀 | デプロイ・リリース |
:warning: | ⚠️ | 注意・警告 |
本文にこのように脚注を付けます[^1]。複数の脚注も可能です[^note]。
[^1]: 脚注の内容はここに書きます。
[^note]: 名前付きの脚注も使えます。GFMではURLを直接書くだけで自動的にリンクになります。
https://github.com
https://example.com~~このテキストに取り消し線が引かれます~~コードブロックの言語に diff を指定すると差分表示ができます。
```diff
- 削除された行
+ 追加された行
変更のない行
```GitHubでは引用ブロック内に特定のキーワードを書くとアラート表示になります。
> [!NOTE]
> 参考情報や補足です。
> [!TIP]
> より良い方法のヒントです。
> [!IMPORTANT]
> 重要な情報です。
> [!WARNING]
> 注意が必要な情報です。
> [!CAUTION]
> 危険な操作に関する警告です。GitHub上では以下の記法で自動リンクが作成されます。
@username ユーザーへのメンション
#123 イシューやPRへの参照
org/repo#123 別リポジトリのイシュー参照