シナリオ

Docsパブリッシングキット

技術ドキュメントの下書き、フォーマット、公開を一括で実現。

3 スキル 7 インストール

documentationmarkdownpublishinghtmlwriting

昨日更新

インストール

このパック内のすべてのスキルをインストールするには、このコマンドを実行してください:

npx skillstore add @docs-publishing-kit

CLI は Codex と Claude Code のフォルダを自動検出し、利用できる場合は両方にインストールします。

概要

使用ガイド

AI が改善しました

詳細ガイド

## 概要
Docsパブリッシングキットは、roughな技術メモを出版可能なドキュメントにするための一つのワークフローを提供します：内容を下書きし、Markdown構造を整理し、共有用の洗練されたHTMLを出力します。

## クイックスタート
1.  plans、proposals、specs、READMEs、notes、guides、またはその他のmarkdownドキュメント出力を作成する必要がある場合に `documentation` から始めます。
2.  下書きに対して `baoyu-format-markdown` を実行し、frontmatter、タイトル、サマリー、見出し、太字テキスト、リスト、コードブロックを整理します。フォーマット済みファイル `{filename}-formatted.md` を出力します。
3.  完成したmarkdownにスタイリングされたHTML出力が必要な場合（コードハイライト、math、PlantUML、脚注、alerts、infographic向きコンテンツの対応を含む）には `baoyu-markdown-to-html` を使用します。

## 主要コマンド
- `documentation` — specs、READMEs、proposals、plans、notes、guides、markdownファイルなどの構造化ドキュメントを下書きします。
- `jimliu-baoyu-format-markdown` / `baoyu-format-markdown` — プレーンテキストまたはmarkdownを見出し、リスト、frontmatter、タイポグラフィを含む、よりクリーンなドキュメントレイアウトにフォーマットします。
- `jimliu-baoyu-markdown-to-html` / `baoyu-markdown-to-html` — 完成したmarkdownをWebまたは richer-contentパブリッシング用のスタイリング済みHTMLに変換します。

## ヒント
- フローを順番に保ち：`documentation` で書き、`baoyu-format-markdown` でPolish、`baoyu-markdown-to-html` で公開。
- HTML変換の前にフォーマット済みmarkdown出力を單一ソースとして使用し、README、spec、公開ページの整合性を保ちます。
- ダイアグラムやmathを含む技術ドキュメントの場合、まずmarkdownを完成させ、`baoyu-markdown-to-html` にPlantUML、math、脚注、alerts、コードハイライトをHTMLエクスポートで処理させます。