markdown-formatting について
Markdown 文書の書式を定めるスキルです。コードフェンス、リスト、表、見出し、区切り線の規則を含み、Torchlight のコードブロックフラグを使う執筆者向けです。
主な機能
- 01見出しとセクション間隔の規則
- 02Torchlight コードブロックフラグ
- 03コードフェンスの言語タグ
- 04リストと表の規則
- 05水平区切り線の指定
活用シーン
- 01ドキュメントページの書式整理
- 02構文ハイライト付きコード例の追加
- 03リストと表の書式統一
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/インストール後、Claude Code で/markdown-formattingを入力して読み込まれたか確認します。
詳細
全般
- 特に指定がない限り、目次は作成しないでください。
- 文の途中でエムダッシュやコロンを使って、2つの考えをつなげないでください。新しい文にするか、接続語（「なぜなら」「そのため」など）を使って読点でつないでください。
コードブロック
すべてのコードブロックに言語タグと Torchlight フラグを指定してください。
| フラグ | 説明 |
|---|---|
+code | ソースコードのみ（構文ハイライト） |
+demo | プレビュー＋コード（常に表示） |
+demo-folded | プレビュー＋コード＋折りたたみ可能 |
ほかのフラグ（+preview、+collapse、output）もありますが、あまり一般的ではありません。リクエストされた場合にのみ使用してください。
言語タグ
| 用途 | タグ |
|---|---|
| ディレクトリツリー、シェルコマンド | ```bash +code |
| Blade テンプレート | ```html +code-blade |
Demo-Folded 属性
+demo-folded を使用するときは、デモ属性を意図的に適用してください。
class="..."— 外側のデモラッパーのスタイルpreview-class="..."— プレビュー専用のレイアウトまたはスタイル
開始タグの例：
```html +demo-folded class="bx" preview-class="grid gap lg:cols-3"
<div class="example">Content here</div>
水平区切り線
--- のテーマ区切りが適切でない長いドキュメントでは、セクションを視覚的に区切るために80個のハイフンを使用してください。
--------------------------------------------------------------------------------
リスト
- 順不同リストにはハイフン
-を使用してください - 順序付きステップには
1.2.を使用してください - 入れ子項目には4つのスペースでインデントしてください
表
標準の GitHub Flavored Markdown を使用してください。列の区切り文字の位置を揃えてください。
| 列 | 型 | NULL 許容 | デフォルト |
|---|---|---|---|
| id | bigint | いいえ | AUTO |
| name | varchar(255) | いいえ | - |
Lint
- 見出し、コードブロック、リストの前後に空行を入れてください
- 行末に空白を入れないでください
- セクション間の空行は1行にしてください。2行は入れないでください
コメント
Markdown 対応