Yamamoto's Laboratory
Markdown

はじめに

Open AI の Codex を使いプログラムの開発を始めました.そのプログラムの仕様を記述するには,Markdown を使うことにしました.そこで,Markdown の使い方をメモします.

基本構文

Markdown でよく使う記法を,すぐ引けるようにカテゴリ別にまとめます.GitHub Flavored Markdown (GFM) を基準にしつつ,一般的な処理系でも通る書き方を優先してあります.

見出し・段落・改行

Markdown の見出し・段落・改行
記法 用途 / 表示 メモ
# 見出し 1 見出し 1 ##, ### のように # を増やすと階層を下げられます.
段落 A

段落 B
段落分け 段落の間は 1 行空けます.改行だけでは同じ段落として扱われます.
行末に半角スペース 2 個
または <br>
行内改行 処理系差を避けたい場合は <br> の方が意図が明確です.
--- 水平線 ***___ でも書けます.

文字装飾・リスト・引用

Markdown の文字装飾・リスト・引用
記法 用途 / 表示 メモ
**太字** 太字 __太字__ でも可です.
*斜体* 斜体 _斜体_ でも可です.
~~取消~~ 打ち消し線 GitHub Flavored Markdown (GFM) でよく使う記法です.
> 引用文 引用 >> とすると入れ子にできます.
- 項目 箇条書き *, + でも書けます.
1. 項目 番号付きリスト 多くの処理系では実際の番号を自動で整形してくれます.
- [ ] 未完了
- [x] 完了
タスク一覧 GFM 系ではチェックボックスとして表示されます.
Markdown のリンク・画像
記法 用途 / 表示 メモ
[表示文字](https://example.com) リンク URL でも相対パスでも指定できます.
<https://example.com> 自動リンク URL をそのまま見せたいときに便利です.
![代替テキスト](image.png) 画像表示 代替テキストを書いておくと内容が分かりやすくなります.
[別ページ](../doc/file.md) 相対リンク リポジトリ内の文書同士をつなぐときに使います.

コード・表・補助記法

Markdown のコード・表・補助記法
記法 用途 / 表示 メモ
`print(i)` インラインコード バッククォート3つ(`)で囲みます.変数名,関数名,コマンド名の明示に向きます.
```python
for i in range(10):
    print(i)
```
コードブロック バッククォート3つ(```)で囲みます.言語名を付けると,対応処理系ではシンタックスハイライトされます.言語名は必須ではありません.
| 列 A | 列 B |
| --- | --- |
| 値 1 | 値 2 |
表は GFM の拡張構文ですが,実務ではよく使います.
$$ LaTeX 数式 $$
LaTeX 数式 $$ で囲みます.具体例: $$ \int_0^1 x^2\,dx = \frac{1}{3} $$
\* エスケープ 記号をそのまま表示したいときは先頭に \ を付けます.
<!-- コメント --> コメント HTML コメントなので,表示には出さずにメモを残せます.
  • 古い Markdown 処理系では,表,打ち消し線,タスク一覧が未対応の場合があります.
  • 行内改行は,行末スペース 2 個よりも <br> の方が意図が伝わりやすいことがあります.
  • 見出しは通常 # から ###### までの 6 段階です.

VS Code での使い方

VS Code では,Markdown ファイルを開いた状態で Ctrl + Shift + V を押すとプレビューを表示できます.横に並べて見たいときは Ctrl + K のあと V を押します.

ページ作成情報

参考資料

更新履歴

2026年03月28日 LaTeX 数式の書き方を追記
2026年03月28日 基本構文と目次を追記
2026年03月28日 ページの新規作成


no counter