Markdown：一度書けば、どこでも公開

ドキュメントを書く必要があります。あるいはREADME。あるいはブログ記事。あるいはフォーマット付きのSlackメッセージ。

HTMLは大げさ。Wordドキュメントはどこでも動かない。プレーンテキストにはフォーマットがない。

Markdownはスイートスポットに位置します。シンプルな構文、プレーンテキストとして読める、必要な時にHTMLに変換。

基本

# 見出し1
## 見出し2
### 見出し3

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

- 箇条書き
- もう一つ
  - ネストされた項目

1. 番号付きリスト
2. 2番目の項目

[リンクテキスト](https://example.com)

![画像のaltテキスト](image.jpg)

これで必要なことのほとんどができます。

コードのフォーマット

バッククォートでインラインコード：console.log('hello')

トリプルバッククォートでコードブロック：

function hello() {
  return 'world';
}

開始バッククォートの後に言語を指定すると、シンタックスハイライトが有効になります。

テーブル

| 名前  | 役割       |
|-------|------------|
| Alice | Developer  |
| Bob   | Designer   |

テーブルは入力が面倒。ほとんどのエディタにショートカットがあります。

引用

> これは引用です。
> 複数行にまたがることができます。

吹き出し、引用、重要なテキストの強調に使います。

なぜMarkdownが機能するか

読めるソース。 レンダリングなしでもMarkdownは読みやすい。**太字** は明らかに太字。

ポータブル。 GitHub、Notion、Slack、Reddit、無数の静的サイトジェネレーター。一度書いて、どこにでも貼り付け。

バージョン管理フレンドリー。 プレーンテキスト。Gitのdiffが意味をなす。マージが機能。

将来性。 独自フォーマットなし。コンテンツは永遠にアクセス可能。

フレーバーの違い

GitHub Flavored Markdown（GFM）はチェックボックス、テーブル、シンタックスハイライトを追加。

CommonMarkは標準化の取り組み。ほとんどのプラットフォームがサポート。

一部のプラットフォームは追加機能：Obsidianにはwikilink、Notionにはデータベース。

最大の移植性には、基本構文に固執しましょう。

よくある失敗

空白行を忘れる。 段落間には空白行が必要。空白行がないと、すべてが繋がります。

見出し後のスペース。 #見出し は動きません。# 見出し は動きます。スペースに注意。

壊れたリンク。 https:// を忘れると、一部のプラットフォームでリンクが失敗します。

altテキストなしの画像。 ![](image.jpg) は動きますが、アクセシブルではありません。説明を追加しましょう。

執筆のコツ

構造のために見出しを使いましょう。読者は読む前にスキャンします。

段落は短く保ちましょう。空白は可読性を助けます。

公開前にプレビュー。レンダラーによってエッジケースの扱いが異なります。

---

Markdownは執筆の摩擦を取り除きます。基本を一度学べば、どこでも使えます。シンプルさこそが機能です。