ストーリー
Markdownとは
Markdownは、テキストファイルに簡単な記号を付けることで、見出しや太字、リストなどの書式を表現できる記法です。
なぜMarkdownを使うのか
| 特徴 | 説明 |
|---|---|
| シンプル | 記号が少なく、覚えやすい |
| テキストベース | 特別なソフトが不要 |
| バージョン管理しやすい | Gitで差分が見やすい |
| どこでも使える | GitHub、Slack、Notion、Qiita… |
基本記法
見出し
# の数で見出しのレベルを表します。
# 見出し1(大見出し)
## 見出し2(中見出し)
### 見出し3(小見出し)
#### 見出し4
ポイント:
#の後にスペースを1つ入れるのを忘れずに
太字・斜体
**太字にしたいテキスト**
*斜体にしたいテキスト*
***太字かつ斜体***
表示結果:
- 太字にしたいテキスト
- 斜体にしたいテキスト
- 太字かつ斜体
リスト
箇条書きリスト(- または * を使用)
- 項目1
- 項目2
- 項目2-1(インデントで入れ子)
- 項目2-2
- 項目3
番号付きリスト
1. 手順1
2. 手順2
3. 手順3
チェックリスト
- [ ] 未完了のタスク
- [x] 完了したタスク
リンク
[表示テキスト](URL)
例:
[Google](https://www.google.com)
コードブロック
インラインコード(文中にコードを書く)
`git status` コマンドで状態を確認します。
表示: git status コマンドで状態を確認します。
複数行のコードブロック
```bash
git add .
git commit -m "メッセージ"
git push
```
言語名を指定するとシンタックスハイライトが効きます。
よく使う言語名: bash, javascript, python, html, css, json, yaml
テーブル(表)
| 名前 | 役割 | 担当 |
|------|------|------|
| 田中 | リーダー | バックエンド |
| 佐藤 | メンバー | フロントエンド |
| 鈴木 | メンバー | インフラ |
表示結果:
| 名前 | 役割 | 担当 |
|---|---|---|
| 田中 | リーダー | バックエンド |
| 佐藤 | メンバー | フロントエンド |
| 鈴木 | メンバー | インフラ |
ポイント:
|でセルを区切り、---でヘッダーと本体を分けます
引用
> これは引用文です。
> 他の人の発言を引用するときに使います。
これは引用文です。 他の人の発言を引用するときに使います。
水平線
---
文書のセクション区切りに使います。
実際に書いてみよう
以下は、ここまで学んだ記法を使った議事録の例です。
# 定例ミーティング議事録
## 基本情報
| 項目 | 内容 |
|------|------|
| 日時 | 2025-04-01 10:00-11:00 |
| 場所 | 会議室A |
| 参加者 | 田中、佐藤、鈴木 |
## アジェンダ
1. 先週の進捗確認
2. 新機能の仕様検討
3. 次週の計画
## 決定事項
- **認証方式はOAuth2.0を採用する**
- リリース日は4月15日とする
## アクションアイテム
- [ ] 田中: OAuth2.0の実装(4/7まで)
- [ ] 佐藤: テストケース作成(4/10まで)
> 次回は4月8日(火) 10:00から
よく使うMarkdownツール
| ツール | 用途 |
|---|---|
| VSCode | プレビュー付きで編集できる |
| GitHub | READMEやIssueで自動レンダリング |
| Notion | Markdownライクな記法が使える |
| HackMD/HedgeDoc | リアルタイム共同編集 |
まとめ
| 記法 | 書き方 | 用途 |
|---|---|---|
| 見出し | # テキスト | 文書の構造化 |
| 太字 | **テキスト** | 強調 |
| リスト | - テキスト | 箇条書き |
| リンク | [テキスト](URL) | 参照先の提示 |
| コード | `コード` | コマンドやコードの表示 |
| テーブル | | セル | セル | | 情報の整理 |
- Markdownの基本記法を学んだ
- 見出し、リスト、テーブルが書ける
- コードブロックが書ける
次のステップへ
Markdownの基本記法は覚えましたか?
次のセクションでは、ドキュメント作成でよく使う基本用語を整理します。 「テンプレート」「フォーマット」「バージョン管理」など、正しく理解しておきましょう。
推定読了時間: 25分