3.Markdown

学習目標

Markdown ファイルを作成し、VS Code でプレビューできる
見出し・リスト・コードブロック・表などの基本記法を使ってドキュメントを書くことができる

1. Markdown

1-1. Markdownとは

Markdown は、テキストに # や - などの記号をつけて、見出しや箇条書きといった構造を表現する記法です。プレーンテキストなので特別なソフトが不要で、ソフトウェア開発の現場で広く使われています。

1-2. 用途

ソフトウェア開発の現場では、Markdown に触れる場面が多くあります。代表的な用途は次の通りです。

用途	例
README	プロジェクトの説明書
技術ドキュメント	仕様書、設計書、手順書
GitHub	Issue、Pull Request、コメント
社内 Wiki	Notion、Confluence など

2. ファイルの作成とプレビュー

VS Code で Markdown ファイルを作って、プレビューで結果を確認します。

ファイルの作成

VS Code で新しいファイル hello.md を作成します。.md は Markdown のファイル拡張子で、.js が JavaScript のファイルを表すのと同じように、「このファイルには Markdown で書かれたテキストがある」ことを示します。
記述と保存

hello.md に以下を記述して保存します。
```
# はじめての Markdown

- 項目 1
- 項目 2
```
プレビュー

Ctrl + Shift + V を押すと、Markdown のプレビューが新しいタブで開きます。# が見出しに、- が箇条書きに変換されて表示されます。

3. 基本記法

3-1. 見出し

# の数で見出しのレベルを表します。

# 見出し 1（最も大きい）
## 見出し 2
### 見出し 3

3-2. リスト

箇条書きは - または *、番号付きは 1. で始めます。

- 項目 1
- 項目 2
  - ネストした項目

1. 最初の手順
2. 次の手順
3. 最後の手順

3-3. コードブロック

バッククォート 3 つで囲みます。言語名を指定すると、シンタックスハイライトが適用されます。

```javascript
const message = "Hello";
console.log(message);
```

文章中で短いコードに触れたいときは、バッククォート 1 つで囲んだ インラインコード を使います。

変数 `message` に文字列を代入します。

3-4. 強調とリンク

重要な部分の強調や URL の埋め込みに使います。

**太字**
*斜体*
[表示テキスト](URL)

3-5. 表

行と列のあるデータや、複数項目の比較を表として表示できます。

| 列 1 | 列 2 | 列 3 |
|---|---|---|
| A | B | C |
| D | E | F |

4. ドキュメントの例

実際のプロジェクトの README を書く例です。見出し・リスト・コードブロックを組み合わせるとドキュメントになります。

# Dev Guides

新人エンジニア研修向けのドキュメントサイトです。

## 主なコンテンツ

- プログラミング基礎（JavaScript）
- データベース基礎（MySQL）
- 生成AI基礎

## セットアップ

依存パッケージをインストールします。

```bash
npm install
```

## 開発

開発サーバーを起動します。

```bash
npm run dev
```

ブラウザーで `http://localhost:4321` を開いて確認できます。

## ビルド

本番用のビルドを生成します。

```bash
npm run build
```

ビルド結果は `dist/` に出力されます。

## デプロイ

main ブランチへの push で Cloudflare Pages に自動デプロイされます。

5. 演習

演習: AIツールレポート