レッスン 1
Markdown とは何か
README、ドキュメント、Issue、CHANGELOG 向けのプレーンテキスト書式として Markdown を理解します。
Markdown は HTML タグなしで構造化ドキュメントを書くためのプレーンテキスト形式です。<h1>Title</h1> の代わりに次のように書きます。
# Title
<strong>important</strong> の代わりに次のように書きます。
**important**
考え方は単純です。ソースをテキストとして読みやすく保ち、ツールに見出し、リスト、リンク、コードブロックとしてレンダリングさせます。
開発者が Markdown を使う場所
Markdown は開発者ワークフローに常に現れます。
- リポジトリの
README.md CHANGELOG.mdのリリースノート- GitHub Issue とプルリクエスト本文
.mdファイルを受け付けるドキュメントサイト- RFC メモ、ランブック、内部ガイド
- Markdown から変換された HTML を受け付ける CMS やメールフィールド
Markdown vs HTML vs WYSIWYG エディタ
| 形式 | 強み | 典型的な用途 |
|---|---|---|
| Markdown | 高速なプレーンテキスト下書き、diff 向き | README、Issue、ドキュメントソース |
| HTML | 完全なレイアウト制御、インラインスタイル | CMS、メール、Web ページ |
| WYSIWYG | ビジュアル編集 | Notion、Confluence、一部 CMS |
多くのチームは Git で Markdown を保持します。バージョン管理、コードレビュー、ツール間のコピー/ペーストに適しているためです。
要点
Markdown は執筆形式であり、テーマやレンダラーではありません。同じ Markdown ファイルでも、GitHub、ドキュメントサイト、プレビューツールでレンダラーと CSS 次第で見え方が異なります。
短い README サンプルで Markdown Preview / Markdown to HTML ツールを試し、ソーステキストがレンダリング出力になる様子を確認してください。