Markdown と MD ファイル入門

Codex 学習目次に戻る

目標と準備

Markdown はプレーンテキストの書式で、.md が一般的な拡張子です。編集する文字を、プレビューが見出しや一覧、リンクへ表示します。Word を改名しても変換されず、コード内の命令もプレビューで実行されません。元の文字と表示を区別して編集します。

手順1：プレーンテキストを作る

新しい codex-md-lab を VS Code で開き、Explorer に README.md と notes.md を作ります。全 OS で大文字小文字も合わせ、README.md.txt にしません。他のエディターなら UTF-8 のプレーンテキストで保存し、拡張子の自動追加を確認します。本番 README を上書きせず新規フォルダーを使います。

例全体を README.md にコピーして保存します。サイト外側のコード枠は表示用で追加しませんが、例に含まれる三つのバッククォートはファイルの一部として残します。英語の共通例と名前を使い、五言語で同じ成果を比較します。

# Small Steps notebook

## Purpose

Keep a short record of this practice project.

## Working steps

1. Read the request.
2. Make one focused change.
3. Verify the result.

- Keep original files.
- Record checks that have not run.

[Open task notes](./notes.md)

## Example command

```sh
node --version
```

> This command is an example, not a record of execution.

次を同じ階層の notes.md に保存します。./notes.md は README の場所から探し、./README.md で戻ります。データベースやサイトのルーティングなしで、小さな目次と分篇の関係を作れます。

# Task notes

[Back to the notebook](./README.md)

## Accepted result

- **Completed** shows only finished tasks.
- `Read` is the sample task title.
- Empty titles must be rejected.

## Pending checks

The browser check has not run yet.

手順2：六つの基本表現を理解する

# と空白は主見出し、## は次の階層です。この筆記は主題一つの下に節を置きます。全てを大見出しにすると構造を失います。見出しを改名したら関連リンクも確認します。見出しアンカーは表示ツールで異なる場合があります。

番号一覧は手順、ハイフン一覧は並列条件向きです。段落間に空行を置きます。二重星印は強調、単一バッククォートは Read などのコード表示ですが、Codex の権限を高めません。> は注記や引用の区別で、検証済みの印ではありません。

リンクは角括弧に表示名、丸括弧に行き先を置きます。例は相対ファイル、サイトは完全な HTTPS URL です。自分の C:\Users は全読者が使えるリンクではなく、ない notes.md は完成文書ではありません。表示名と違ってもよいですが、行き先と大文字小文字は正確にします。

コードは開始と終了のバッククォートで囲み、sh は表示用の言語名です。命令は内側、注記は外側に置きます。終了がなければ残りもコードになり得るので、再導入でなく区切りを戻します。半角文字を保ち、バッククォートを普通の引用符に置き換えません。

Markdown のコードフェンス自体を見せる

次の断片全体を notes.md の末尾に追加して保存します。外側の四つのバッククォートも保存する内容で、内側の三つを文字として表示します。プレビューでは開始の三つのバッククォートと sh、終端の三つのバッククォートが見え、その後の一文は枠の外に出ます。GitHub 公式文書で説明されている入れ子の書き方です。

## Show the Markdown source

````markdown
```sh
node --version
```
````

This paragraph is outside the example.

最後の文まで枠内に入る場合は、外側の終端が四つのバッククォートか数えます。三つでは四つの開始を閉じられません。終端だけ直して再確認してください。この追加練習を戻すときは追加した節だけを取り除き、元の二文書と相互リンクは残します。

手順3：プレビュー、リンク、失敗の練習

VS Code で README.md を開き Markdown: Open Preview、または Windows / Linux の Ctrl+Shift+V、macOS の Command+Shift+V を使います。元とプレビューは同じファイルの二つの表示です。保存して主題、手順、二条件、コードを確認します。

個人設定や拡張機能でキーが変わることがあります。開かない場合はコマンドパレットで Markdown: Open Preview を探し、表示された割り当てを確認するか直接実行します。別の一覧から推測せず、未操作の OS は公式文書による確認として扱います。

Open task notes で同じフォルダーの notes.md を開き、戻るリンクを確認します。編集タブになればそのファイルをプレビューします。同じ題名だけで判断しません。次に行き先を ./missing.md にして失敗を確認し、./notes.md へ戻して双方向を再確認します。

追加練習では README.md を保存コピーして終了フェンスだけを消し、注記がコードに入る様子を見て戻します。場所、見出し、区切りを同時に変えず一つずつ確認します。デバッグの練習にもなります。

手順4：Codex に文書を読ませる

デスクトップ、CLI、IDEで codex-md-lab を開いて場所を確認し、次を送ります。読み取りと比較だけで例の命令は実行しません。名前が見えるだけでは読んだ証拠でないため、出典と未完了を確認します。

Read README.md and notes.md in this practice folder. Explain the purpose, the accepted result, and the checks explicitly still pending. Identify each source file. Verify both relative file links point to existing files. Do not edit anything or execute the example command.

README の手順、notes の Completed、Read、空白条件と、ブラウザー未実行が説明されれば確認できます。例を実行済みと言えば根拠と訂正を求めます。命令や成功条件の記載は実行記録ではありません。読み取り結果と独立したリンク確認を残します。

通常の .md と AGENTS.md の違い

今回は AGENTS.md を作っていないので自動読込の確認ではありません。AGENTS.mdで範囲と検証、SKILL.mdで技能を学びます。Markdown の読みやすさと、ツールが発見して使う規則は別です。他者の筆記を自分への操作指示と混同しません。

二つの実ファイル、双方向リンク、コード表示、欠落の修復、条件と未実行を区別する返答を残します。字形や余白が違っても構造、内容、行き先が一致すればよく、VS Code の表示とリンクは公式資料で確認しました。独自例は入れ子フェンスと多言語でのコード保持をコンパイル・コピーでも検証します。

Codex 学習目次に戻る

詳しい説明を読む

Plain text to README.md to Preview

• AIツール
• チュートリアル
• Codex