Pythonバイブコーディング講座 — 補足記事
README.md を書くために最低限知っておきたい記法
Markdown（マークダウン）は、テキストに少し記号を添えるだけで、見出し・リスト・コードなどの装飾が表現できる「軽量な書式ルール」です。README.md、GitHub の Issue／Pull Request、Notion、Slack、Zenn、Qiita など、多くのサービスで使われています。本ページでは、Pythonバイブコーディング講座の Part 4 で README.md を書くために最低限知っておきたい記法をまとめます。覚えるのは見出し・コードブロック・リストの3つだけで十分です。
行の先頭に # を付けると見出しになります。# の数が少ないほど大きな見出しになり、##・### と数を増やすほど階層が深くなります。
小見出し（H3）
# と見出しテキストの間には半角スペースを必ず入れてください。#見出し ではなく # 見出し です。
コードやコマンドは、3つのバッククォート（```）で前後を囲むと、固定幅フォントで枠囲みに表示されます。
```
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
```
最初の ``` の直後に言語名（python、bash、html など）を書くと、その言語に合わせて色分け（シンタックスハイライト）されます。
```python
import pandas as pd
df = pd.read_excel("data.xlsx")
print(df.describe())
```
文中で短いコードを引用したい場合は、バッククォート1つで囲みます。`pip install pandas` と書くと、pip install pandas のように表示されます。
箇条書きは行頭に -（ハイフン）か *（アスタリスク）を付けます。番号付きリストは 1.・2. のように書きます。
余裕があれば覚えておくと便利な、応用的な記法を紹介します。
**重要** → 重要*強調* → 強調[表示テキスト](URL) → 例：[GitHub](https://github.com)
Part 4 で示した README.md をMarkdown記法で書くと、次のようになります。
# 〇〇研究の解析パッケージ
本リポジトリには、〇〇論文の図表を再現するためのPythonコード一式が含まれています。
## 環境構築
```
python -m venv .venv
source .venv/bin/activate # Windows: .venv\Scripts\Activate.ps1
pip install -r requirements.txt
```
## 実行
VSCode で `analysis.ipynb` を開き、上から順にセルを実行してください。
結果は `results/` フォルダに保存されます。
## Pythonバージョン
Python 3.12 で動作確認しています。
## 連絡先
質問は [Issues](https://github.com/yourname/repo/issues) からお寄せください。
このファイルを GitHub にアップロードすると、リポジトリのトップページに自動的に整形表示されます。
Markdown記法に慣れていなくても、ChatGPTやClaudeに「以下の内容で README.md を書いて」と頼めば、Markdown形式で出力してくれます。最初は LLM に任せて出力を見ながら覚えるのも良い学び方です。
# 〜 ###：見出し``` 〜 ```：コードブロック- または 1.：リスト**太字**・*斜体*・[リンク](URL)：装飾とリンク
VSCode で .md ファイルを開いた状態で Ctrl + Shift + V（Macは Cmd + Shift + V）を押すと、書きながらプレビューを確認できます。