runme-conventions

hyt-sasaki 的头像作者 hyt-sasaki

Runme.dev格式可执行Markdown的创建和编辑规范。使用时机:(1) 在Markdown文件中添加可执行代码块(verify.md, README.md等)(2) 添加或编辑Runme.dev单元格设置(name, cwd, excludeFromRunAll等)(3) 使用runme fmt进行格式化(4) 修正或改进现有Runme文件

📖 中文导读:Runme.dev格式可执行Markdown的创建和编辑规范。使用时机:(1) 在Markdown文件中添加可执行代码块(verify.md, README.md等)(2) 添加或编辑Runme.dev单元格设置(name, cwd, excludeFromRunAll等)(3) 使用runme fmt进行格式化(4) 修正或改进现有Runme文件 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。

name: runme-conventions description: | Runme.dev形式の実行可能マークダウン作成・編集用規約。 使用タイミング: (1) マークダウンファイルに実行可能なコードブロックを追加(verify.md, README.mdなど) (2) Runme.devセル設定の追加・編集(name, cwd, excludeFromRunAllなど) (3) runme fmtでフォーマット適用 (4) 既存Runmeファイルの修正・改善 allowed-tools: Read, Bash(runme fmt:*)

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>

詳細リファレンス