runme-conventions

Convention for creating and editing executable markdown in the Runme.dev format. Usage timing: (1) Add executable code blocks to markdown files (e.g., verify.md, README.md, etc.) (2) Add or edit Runme.dev cell settings (e.g., name, cwd, excludeFromRunAll, etc.) (3) Apply formatting with runme fmt (4) Modify and improve existing Runme files

Runme.dev規約

クイックスタート

コードブロックにJSON形式でセル設定を追加:

```bash {"name":"deploy","cwd":"../mcp-server"}
npm run deploy
```

主要オプション

| オプション | 説明 | 例 | |-----------|------|-----| | name | タスク名（runme run <name>で実行） | {"name":"deploy"} | | cwd | 作業ディレクトリ（mdファイルからの相対パス） | {"cwd":"../mcp-server"} | | excludeFromRunAll | runme run --allから除外 | {"excludeFromRunAll":"true"} | | ignore | CLI・ノートブック変換から完全除外（runme listにも表示されない） | {"ignore":"true"} |

フォーマット

コミット前にrunme fmtを実行してVSCode拡張機能との差分を防止:

runme fmt -w --filename <target.md>

詳細リファレンス

全セルオプション: references/cell-options.md
ベストプラクティス: references/best-practices.md
公式ドキュメント: https://docs.runme.dev/configuration/cell-level