Markdown構文ガイド：基礎から応用まで

Markdownは開発者が実際に楽しんで使える文書フォーマットです。書式設定メニューをクリックしたり、WYSIWYGエディタと格闘する必要はありません — いくつかの記号を含むプレーンテキストがクリーンなHTMLに変換されます。READMEファイル、ドキュメント、ブログ記事、チャットメッセージ、そしてこの記事もMarkdownで書かれています。

当サイトのMarkdownプレビューアーでMarkdownをリアルタイムでプレビューできます — 片側で書き、もう片側でフォーマットされた出力を確認できます。

基本構文

見出し

# Heading 1
## Heading 2
### Heading 3
#### Heading 4

見出しは階層的に使用してください。レベルを飛ばさない（H1からH3に飛ぶなど）でください — 可読性とアクセシビリティの両方を損ないます。

強調

*italic* or _italic_
**bold** or __bold__
***bold italic***
~~strikethrough~~

リンクと画像

[Link text](https://example.com)
[Link with title](https://example.com "Title")
![Alt text](image.png)

引用

> This is a blockquote.
> It can span multiple lines.

コード

インラインコード

バッククォートでインラインコードを記述します: `const x = 42`

コードブロック

トリプルバッククォートとオプションの言語識別子：

```javascript
function greet(name) {
  return `Hello, ${name}!`;
}
```

対応言語にはjavascript、python、json、yaml、html、css、bashなど多数があります。

テーブル

| Header 1 | Header 2 | Header 3 |
|----------|----------|----------|
| Cell 1   | Cell 2   | Cell 3   |
| Cell 4   | Cell 5   | Cell 6   |

配置：

| Left | Center | Right |
|:-----|:------:|------:|
| L    |   C    |     R |

応用構文

タスクリスト

- [x] Completed task
- [ ] Pending task
- [ ] Another task

脚注

Here is a statement[^1].

[^1]: This is the footnote content.

定義リスト

Term
: Definition of the term

水平線

---
***
___

GitHub Flavored Markdown（GFM）

GitHubは標準的なMarkdownを便利な機能で拡張しています：

URLの自動リンク — 裸のURLがクリック可能になる
タスクリスト — IssueやPRでのチェックボックス
テーブル — 上記のパイプ構文
取り消し線 — ~~deleted text~~
シンタックスハイライト — 言語固有のコード色分け
絵文字 — :smile: がスマイルフェイスになる

執筆のヒント

段落は短く — 最大3〜5文
見出しを使ってスキャンしやすい構造を作る
手順や機能にはリストを使い、長い段落を避ける
技術的な概念を説明する際はコード例を追加する
定期的にプレビューする — 当サイトのMarkdownプレビューアーで入力中にリアルタイムで出力を確認できます

よくある質問

MarkdownとHTMLの違いは何ですか？

MarkdownはHTMLに変換される簡略化された文書フォーマットです。より少ない構文で最も一般的な書式設定のニーズをカバーします。Markdownがサポートしていない機能が必要な場合は、Markdown内に生のHTMLを埋め込むことができます。

どのMarkdownフレーバーを使うべきですか？

GitHub Flavored Markdown（GFM）が最も広くサポートされています。標準的なMarkdownにテーブル、タスクリスト、取り消し線を追加しています。CommonMarkは標準化された仕様です。

Markdownをドキュメントに使えますか？

もちろんです。MarkdownはREADMEファイル、Wiki、ドキュメントサイトの標準です。MkDocs、Docusaurus、GitBookなどのツールはすべてMarkdownを使用しています。