Markdown(マークダウン)は、軽量マークアップ言語の一つです。READMEファイル、ブログ記事、技術文書などに広く使われています。以下では、Markdownの書き方と、使うメリット・デメリットを具体的に紹介します。
✅ Markdownのメリット
- シンプルで読みやすい構文
- HTMLに変換しやすい
- プレーンテキストなので軽量
- Gitでのバージョン管理と相性が良い
- 学習コストが低い
Markdownファイル(
.md)は、差分が明確なのでGitでの管理が非常にしやすいという大きな利点があります。具体的には、行単位で変更が管理できるため、変更点の確認(diff)が視覚的に分かりやすく、マージやレビュー作業もスムーズに行えます。また、バージョン履歴を辿ることで過去の修正内容も簡単に把握できます。
❌ Markdownのデメリット
- 高度なレイアウトには不向き
- 表現力がHTMLやWordなどより制限される
- 実装によって微妙な仕様の違いがある(例:GitHub Flavored Markdown)
Markdown記法の基本
見出し(Heading)
表示例
見出し1
見出し2
見出し3
見出し4
見出し5
見出し6
記述例
# 見出し1
## 見出し2
### 見出し3
#### 見出し4
##### 見出し5
###### 見出し6強調(Emphasis)
表示例
- 斜体
- 太字
取り消し線
記述例
*斜体*
**太字**
~~取り消し線~~箇条書き(List)
表示例(順序なしリスト)
- りんご
- 青森産
- 長野産
- みかん
記述例
- りんご
- 青森産
- 長野産
- みかん表示例(順序付きリスト)
- 準備する
- 書く
- 確認する
記述例
1. 準備する
2. 書く
3. 確認する引用(Blockquote)
表示例
これは引用です。
ネストした引用もできます。
記述例
> これは引用です。
>> ネストした引用もできます。コード(Code)
インラインコード表示例
例:console.log("Hello, Markdown!");
インライン記述例
`console.log("Hello, Markdown!");`コードブロック表示例
function greet(name) {
return `Hello, ${name}!`;
}コードブロック記述例
```javascript
function greet(name) {
return `Hello, ${name}!`;
}
```リンク(Links)
表示例
記述例
[Google](https://www.google.com)画像(Images)
表示例
![]()
記述例
水平線(Horizontal Rule)
表示例
記述例
---表(Table)
表示例
| 名前 | 年齢 | 職業 |
|---|---|---|
| 田中 | 30 | エンジニア |
| 山本 | 25 | デザイナー |
記述例
| 名前 | 年齢 | 職業 |
| -- | -- | ----- |
| 田中 | 30 | エンジニア |
| 山本 | 25 | デザイナー |その他の便利な拡張(環境による)
チェックリスト(GitHubなど対応環境)
表示例
- 書く
- 推敲する
- 公開する
記述例
- [x] 書く
- [ ] 推敲する
- [ ] 公開する終わりに
Markdownは、簡潔かつ視認性の高いドキュメントを素早く作成するためのツールとして非常に優れています。特に、Gitとの親和性が高く、技術者にとっては欠かせない存在です。一方で、デザインや複雑なレイアウトには向かないため、用途に応じて使い分けるとよいでしょう。
コメント