Communitygithub.com

abertanha/md-to-wiki-docs-skills

Markdown仕様書をドキュメントサイトに変換します。

md-to-wiki-docs-skills とは?

このスキルは、Markdown形式の仕様書ファイルを、MkDocs Material、Swagger UI、GitHub Wiki、DokuWiki、PDFなど、複数のドキュメント形式に変換するためのルーター兼ワークフローエンジンです。OpenCodeや類似のAIエージェント上で動作し、ユーザーの要求を解析して適切な変換パスを選択します。オンボーディングフェーズではプロジェクト名やソースディレクトリ、想定読者をヒアリングし、生成後にはGitHubのIssueやPRリファレンスの追加、ホスティングへのデプロイまでをカバーします。WindowsとUnixの両方をサポートし、スクリプトファイル(.shおよび.ps1)を介して一貫したインターフェースを提供するため、開発者は手間をかけずにドキュメントサイトを構築・公開できます。

対応~Claude Code~Codex CLI~Cursor✓OpenCode
npx skills add abertanha/md-to-wiki-docs-skills

お気に入りのAIに質問する

このエージェントスキルを事前に読み込んだ状態で新しいチャットを開きます。

ドキュメント

md-to-wiki — シンルーター(フェーズ2)

Markdown仕様書をドキュメントサイトに変換します。

トリガー: "wikiを構築", "ドキュメントを生成", "仕様を公開", "サイトを作成", "MarkdownからWiki", "図を描画", "フローチャート", "アーキテクチャ図", "状態図", "シーケンス図"

フェーズルーター

ユーザーのリクエストを解析し、どのパスを取るかを決定します。

lower=$(echo "$1" | tr '[:upper:]' '[:lower:]')
case "$lower" in
  *"分からない"*|*"ヘルプ"*|*"おすすめ"*)     ROUTE="onboarding" ;;
  *"html"*|*"サイト"*|*"mkdocs"*|*"material"*)  ROUTE="mkdocs" ;;
  *"swagger"*|*"openapi"*|*"api"*)          ROUTE="swagger" ;;
  *"github wiki"*|*"wikiタブ"*)             ROUTE="github-wiki" ;;
  *"dokuwiki"*|*"doku"*)                    ROUTE="dokuwiki" ;;
  *"pdf"*|*"印刷"*|*"本"*)               ROUTE="pdf" ;;
  *"参照"*|*"issue"*|*"pr"*|*"プル"*)  ROUTE="references" ;;
  *"デプロイ"*|*"公開"*|*"公開する"*)       ROUTE="deploy" ;;
  *)                                          ROUTE="onboarding" ;;
esac

次に、適切なエージェントを起動します。

ルートエージェント説明
onboardingagents/onboarding.mdユーザーにインタビュー、OSを検出、SKILL_DIRを設定
mkdocsagents/format-mkdocs.mdMkDocs Materialサイトを生成
swaggeragents/format-swagger.mdOpenAPI 3.0 + Swagger UIを生成
github-wikiagents/format-github-wiki.mdGitHub Wikiに公開
dokuwikiagents/format-dokuwiki.mdDokuWiki形式に変換
pdfagents/format-pdf.mdPandoc経由でPDFを生成
referencesagents/references.mdGitHub Issue/PR参照でドキュメントを充実
deployagents/deploy.md生成したドキュメントをホスティングにデプロイ

実行フロー

  1. オンボーディング → 質問を行う: プロジェクト名、ソースディレクトリ、想定読者(開発者/ステークホルダー/一般)、希望する形式。OSを一度検出し、SKILL_DIR、SCRIPT_EXT、SCRIPT_RUNNERを保存。
  2. フォーマット生成 → 適切なフォーマットエージェントを読み込む。scripts/内の付属スクリプトを$SCRIPT_RUNNERで使用。
  3. 参照 → ユーザーがIssue/PR参照を希望する場合、references.mdを読み込む。
  4. デプロイ → 生成後、deploy.mdを読み込んでホスティングを提供。

グローバル変数(オンボーディング中に一度設定)

  • SKILL_DIR — このスキルフォルダへの解決済みパス
  • SCRIPT_EXT — .sh または .ps1
  • SCRIPT_RUNNER — "" または "powershell -File"
  • OS_TYPE — unix または windows
  • PROJECT_NAME — ユーザーから取得
  • SOURCES — 仕様ファイルへのパス
  • AUDIENCE — developer、stakeholder、general のいずれか

付属スクリプト

すべて.shと.ps1で位置引数を同一に受け付けます。

スクリプト目的
discover-sourcesディレクトリをスキャンしてspec/project/codebase/quickファイルを検出
generate-mkdocs完全なmkdocs.yml + ページ構造を作成
generate-index想定読者に適したランディングページを構築
to-dokuwikiMarkdownをDokuWiki構文に変換
to-pdf結合し、pandoc経由でPDFに変換
fetch-issuesGitHub Issue/PRメタデータをキャッシュ

複数ディレクトリ入力

実行前に複数のソースディレクトリをmerged-specs/にマージします。

mkdir -p merged-specs && cp -r .specs/* docs/* merged-specs/

共有方法

md-to-wiki/を同僚の.config/opencode/skills/または.opencode/skills/にコピーします。依存関係はフォーマットによって異なります。

関連スキル