目次
テキストの基本装飾
文章の構造や強調を示します。
目的 | 記法 | 表示例 | 補足 |
---|---|---|---|
見出し 1 |
| 見出し 1 | 最も大きな見出し。HTMLの`h1`タグに相当。 |
見出し 2 |
| 見出し 2 | HTMLの`h2`タグに相当。`—` は水平線と区別するため、前の行にテキストが必要。 |
見出し 3 |
| 見出し 3 | HTMLの`h3`タグに相当。 |
見出し 4 |
| 見出し 4 | HTMLの`h4`タグに相当。 |
見出し 5 |
| 見出し 5 | HTMLの`h5`タグに相当。 |
見出し 6 |
| 見出し 6 | HTMLの`h6`タグに相当。最も小さな見出し。#は最大6つまで。 |
段落 |
| これは通常のテキスト段落です。 次の段落は空行を挟んで記述します。 | テキストは通常、段落として扱われます。段落間は1行以上の空行で区切ります。 |
強制改行 | または
| 行末にスペースを2つ以上入力 次の行 | 段落内で改行したい場合に使用。環境によってはバックスラッシュが利用可能。 |
太字 (Bold) | または
| 太字テキスト | アスタリスク2つ、またはアンダースコア2つで囲みます。 |
斜体 (Italic) | または
| 斜体テキスト | アスタリスク1つ、またはアンダースコア1つで囲みます。単語中の `_` は斜体にならないことがあります。 |
太字 + 斜体 | または または
| 太字斜体テキスト | アスタリスク3つ、またはアンダースコア3つで囲みます。組み合わせも可能。 |
打ち消し線 |
| GFM (GitHub Flavored Markdown) などの拡張機能で利用可能。標準Markdownには含まれない場合がある。 |
リストの作成 箇条書き
項目を列挙する場合に使用します。
目的 | 記法 | 表示例 | 補足 |
---|---|---|---|
順序なしリスト | または または
|
| 行頭に `-`, `*`, `+` のいずれかとスペースを記述。インデント(通常スペース2つまたは4つ)でネスト可能。記号の混在も可能。 |
順序付きリスト |
|
| 行頭に `数字.` とスペースを記述。数字は連番でなくても、開始が1でなくても、自動で連番表示されることが多い。インデントでネスト可能。 |
順序付きリスト (開始番号指定) |
|
| 最初の数字を開始番号として認識するパーサーが多い。 |
リスト内の段落 |
|
| リスト項目内で段落を追加するには、空行を挟み、次の行をリストのインデントに合わせて記述。 |
リスト内のコードブロック |
|
| コードブロックはリストのインデントレベルより深くインデントする(通常、リスト記号の開始位置から4スペースまたは1タブ)。 |
タスクリスト (チェックボックス) |
|
| GFMなどの拡張機能。順序なしリストの項目の先頭に `[ ]` (未完了) または `[x]` (完了) を記述。スペースが必要。 |
コードの表示
ソースコードやコマンドを記述する際に使用します。
目的 | 記法 | 表示例 | 補足 |
---|---|---|---|
インラインコード |
| 文章中に code を埋め込む。 | バッククォート (`) でコード部分を囲む。コード内にバッククォートを含める場合は、二重バッククォートで囲むなど工夫が必要(例: “ `内側のバッククォート` “)。 |
コードブロック (インデント) |
| 通常のテキスト | 行頭に4つのスペースまたは1つのタブを入力するとコードブロックになる。前の行は空行である必要がある。シンタックスハイライトは通常サポートされない。 |
コードブロック (フェンス) | または
|
| GFMなどの拡張機能で推奨される形式。バッククォート3つ (“`) またはチルダ3つ (~~~) でコード部分を囲む。インデント形式より扱いやすい。 |
コードブロック (シンタックスハイライト付き) |
|
| フェンスコードブロックの開始 “` の直後に言語名を指定すると、対応環境でシンタックスハイライトが適用される。例: `python`, `javascript`, `html`, `css`, `ruby`, `go`, `csharp` など。 |
リンクの挿入
他のWebページやドキュメント内のセクションへの参照を作成します。
目的 | 記法 | 表示例 | 補足 |
---|---|---|---|
インラインリンク |
| 表示テキスト | 最も一般的なリンク形式。`[]` 内に表示するテキスト、`()` 内にリンク先のURLを記述。URLの後ろにスペースを空けて `” “` で囲むと、マウスオーバー時に表示されるタイトル属性を設定可能。 |
参照リンク |
| 表示テキスト | リンク定義を本文とは別の場所にまとめる形式。`[参照ID]` は省略可能で、その場合は `[表示テキスト]` が参照IDとして扱われる(例: `[Google]`, `[Google]: https://www.google.com`)。参照定義 `[参照ID]: URL` はドキュメント内のどこにでも記述可能(通常は末尾にまとめる)。参照IDは大文字小文字を区別しないことが多い。 |
自動リンク (URL) |
| https://www.example.com | URLを `<>` で囲むと、そのURL自身がリンクテキストとなるリンクが自動的に生成される。 |
自動リンク (Email) | または
| mailto:address@example.com | メールアドレスを `<>` で囲むと、`mailto:` リンクが自動生成される。`mailto:` プレフィックスは省略可能な場合が多い。 |
相対リンク |
| 同じディレクトリの別ファイル サブディレクトリのファイル 親ディレクトリのファイル | 同じサイトやリポジトリ内の別ファイルへのリンク。パスの指定方法はOSやWebサーバーのルールに従う。 |
内部リンク (フラグメント識別子) |
| セクションへ移動 | 同じドキュメント内の特定の見出しへのリンク。`#` の後に続くIDは、通常、見出しテキストを小文字化し、スペースをハイフンに置き換え、特殊文字を除去したものになるが、Markdownパーサーやプラットフォームによって生成ルールが異なる場合があるため注意が必要。GitHubなどでは自動的にアンカーが生成される。 |
画像の挿入
ドキュメント内に画像を表示します。
目的 | 記法 | 表示例 (テキストで代替) | 補足 |
---|---|---|---|
インライン画像 |
| (画像: 代替テキスト) | リンクの記法の先頭に `!` を付ける。`[]` 内には画像が表示されない場合に表示される代替テキスト (alt属性) を記述。`()` 内に画像のURLを記述。タイトル属性も指定可能。 |
参照画像 |
| (画像: 代替テキスト) | 参照リンクと同様の形式で画像を挿入。画像定義を別の場所にまとめることができる。 |
リンク付き画像 |
| (リンク付き画像: 代替テキスト) | 画像記法全体をリンク記法 `[]()` で囲むことで、クリック可能な画像を作成できる。 |
相対パス画像 |
| (画像: ロゴ) | Web上のURLだけでなく、ローカルファイルシステム上の相対パスや絶対パスも指定可能(表示環境に依存)。 |
注意: Markdown自体には画像のサイズ調整や回り込みを指定する標準的な方法はありません。これらが必要な場合は、HTMLタグを直接使用するか、拡張機能やCSSに依存する必要があります。
引用ブロック
他の文章や発言を引用する際に使用します。
目的 | 記法 | 表示例 | 補足 |
---|---|---|---|
基本的な引用 | または
| これは引用文です。 | 行頭に `>` とスペースを記述。引用内の改行も反映される。段落ごとに `>` を付けるのが確実。 |
ネストされた引用 |
| レベル1の引用レベル2の引用レベル1に戻る | `>` を重ねることで引用をネストできる (`>>`, `>>>` …)。 |
引用内の他の要素 |
|
| 引用ブロック内でも、見出し、リスト、コードブロックなどの他のMarkdown要素を使用できる。各行の先頭に `>` を付ける必要がある。 |
水平線
セクションの区切りなど、視覚的な境界線を示します。
目的 | 記法 | 表示例 | 補足 |
---|---|---|---|
水平線 |
| アスタリスク (`*`)、ハイフン (`-`)、またはアンダースコア (`_`) を3つ以上、行全体に記述する。記号の間にスペースを入れても良い(例: `* * *`)。前後に空行を入れることが推奨される。見出しの代替記法 (`—`) と混同しないよう注意。 |
テーブル(表)の作成
データを整理して表示する際に使用します。
目的 | 記法 | 表示例 | 補足 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
基本的なテーブル |
|
| GFMなどの拡張機能で一般的にサポートされる。パイプ (`|`) で列を区切り、2行目にハイフン (`-`) を3つ以上並べてヘッダーと本体を区切る。行頭と行末のパイプは省略可能な場合もある。 | ||||||||||||
列のアラインメント(配置) |
|
| 2行目のハイフンの左右にコロン (`:`) を付けることで、列ごとのテキスト配置を指定可能。 `:—` (左寄せ、デフォルト) `:—:` (中央寄せ) `—:` (右寄せ) | ||||||||||||
テーブル内のMarkdown要素 |
|
| セル内では、インラインのMarkdown要素(太字、斜体、コード、リンク、画像など)を使用できることが多い。ただし、リストやブロック要素(複数行のコードブロック、引用など)は通常サポートされないか、表示が崩れる可能性がある。 |
注意: テーブル記法は標準Markdownには含まれておらず、GFMや他の拡張機能の一部です。対応していない環境ではプレーンテキストとして表示されます。
エスケープ
Markdownの記法として解釈される文字を、そのまま表示したい場合に使用します。
目的 | 記法 | 表示例 | 補足 |
---|---|---|---|
特殊文字のエスケープ |
| *アスタリスク*を表示したい。 # シャープを表示したい。 [角括弧]を表示したい。 `バッククォート`を表示したい。 | Markdown記法に使われる文字(例: `\`, “ ` “, `*`, `_`, `{`, `}`, `[`, `]`, `(`, `)`, `#`, `+`, `-`, `.`, `!`, `|`)の直前にバックスラッシュ (`\`) を置くことで、その文字をリテラル文字として表示できる。 |
HTMLタグのエスケープ |
| <h1>これは見出しではない</h1> | HTMLタグをそのまま表示したい場合も `\` でエスケープできることが多い。ただし、多くのMarkdownパーサーは `<` や `&` などを自動的にHTMLエンティティ (`<`, `&`) に変換するため、コードブロック内でない限り、エスケープが常に必要とは限らない。 |
拡張構文(GFMなど)
標準Markdownには含まれないが、GitHub Flavored Markdown (GFM) や他のプラットフォームでよく利用される便利な記法です。
機能 | 記法例 | 表示例 | 補足 |
---|---|---|---|
打ち消し線 |
| テキストを `~~` で囲む。(基本装飾で既出) | |
タスクリスト |
|
| リスト項目で `[ ]` または `[x]` を使用。(リストで既出) |
テーブル |
| (テーブルセクション参照) | パイプ `|` とハイフン `-` で作成。(テーブルで既出) |
絵文字ショートコード |
| `:emoji_name:` の形式で絵文字を挿入。対応する絵文字や名前はプラットフォーム依存。 | |
自動URLリンク | (環境による) | www.github.com | URLやメールアドレスをそのまま記述すると自動的にリンクに変換する機能。`< >` で囲むのが確実。(リンクで既出) |
メンション (@) |
| @username | GitHub, Slackなどで、`@` に続けてユーザー名を書くと、そのユーザーへの通知やリンクが生成される。プラットフォーム固有機能。 |
Issue/PR参照 (#) |
| #123 | GitHubなどで、`#` に続けてIssueやPull Requestの番号を書くと、それらへのリンクが生成される。プラットフォーム固有機能。 |
脚注 |
| ここに脚注への参照[1]があります。 | `[^識別子]` で参照を、`[^識別子]: 説明` で脚注内容を定義。識別子は数字や文字列が使えることが多い。表示形式は環境による。 |
定義リスト |
|
| 一部のMarkdownプロセッサ(Pandoc, Python-Markdownの拡張など)でサポート。用語の次の行に `:` または `~` を置いて定義を記述。 |
ハイライト |
| ハイライトされるテキスト | 一部のMarkdown拡張(Marked.jsなど)でサポート。テキストを `==` で囲む。 |
下付き文字 |
| H2O | 一部のMarkdown拡張(Pandocなど)でサポート。テキストを `~` で囲む。 |
上付き文字 |
| x2 | 一部のMarkdown拡張(Pandocなど)でサポート。テキストを `^` で囲む。 |
注意: これらの拡張構文は、使用しているMarkdownエディタ、プレビューア、静的サイトジェネレーター、プラットフォーム(GitHub, GitLabなど)が対応している場合にのみ正しく表示・機能します。互換性に注意が必要です。
HTMLの直接利用
Markdownで表現できない複雑なレイアウトや要素を使用したい場合、HTMLタグを直接記述することができます。
目的 | 記法例 | 表示例 | 補足 |
---|---|---|---|
HTMLタグの使用 |
| これはMarkdownテキストです。 これは青色のHTML div要素内のテキストです。
| Markdown文書内にHTMLタグを直接記述できます。多くのMarkdownパーサーはHTMLタグをそのまま出力します。 |
HTMLブロック要素内のMarkdown |
| 詳細はこちらここにはMarkdownが使える場合がある ただし、ブロックレベルHTMLタグ( | HTMLのブロック要素(例: ` `, ` `, ` `)の内部でMarkdown記法が有効になるかは、Markdownパーサーの設定や仕様に依存します。一般的には、HTMLブロック要素の開始タグと終了タグの間は、Markdownとして解釈されません。改行の扱いなどもHTMLのルールに従います。 |
インラインHTML |
| 通常のテキスト、緑色のスパン、続きのテキスト。 | インライン要素 (``, ``, ` |
HTMLコメント |
| 表示されるテキスト。 | HTMLのコメントアウト (``) を使用して、最終的な出力には表示されないメモを残すことができます。 |
注意: HTMLの直接利用はMarkdownのシンプルさを損なう可能性があります。また、セキュリティ上の理由から、プラットフォームによっては許可されていないHTMLタグや属性がある場合があります(例: `