Markdownとは
Markdownは、プレーンテキストに特定の記号を使って装飾を表現する軽量マークアップ言語です。2004年にJohn Gruberが考案し、GitHubのREADMEやQiita・Zennの技術記事、Notionのドキュメントなど、エンジニアの世界で標準的に使われています。
基本的な記法
- 見出し:
# H1、## H2、### H3 - 太字:
**テキスト** - 斜体:
*テキスト* - リスト:
- 項目(順不同)、1. 項目(順序付き) - リンク:
[テキスト](URL) - 画像:
 - インラインコード:バッククォートで囲む
- コードブロック:バッククォート3つで囲み、言語名を指定
- 引用:
> テキスト - 水平線:
---
GitHub Flavored Markdown(GFM)
GitHubはMarkdownを拡張したGFMをサポートしています。追加機能として、チェックボックスリスト(- [x])、テーブル記法、Issueやコミットへの自動リンクなどがあります。
Markdownのメリット
- プレーンテキストなのでGitで差分管理しやすい
- どのエディタでも書ける
- HTMLに変換できるため、ブログやドキュメントサイトに応用しやすい
- 読みやすいソースコード(HTMLより視認性が高い)