Communitygithub.com

abertanha/md-to-wiki-docs-skills

Verwandle Markdown-Spezifikationsdateien in Dokumentationsseiten.

Was ist md-to-wiki-docs-skills?

Dieses Skill fungiert als dünner Router (Phase 2) für die Umwandlung von Markdown-Dateien in verschiedene Dokumentationsformate. Es analysiert die Benutzeranfrage, um den optimalen Pfad zu wählen: von MkDocs-Material-Seiten über Swagger-API-Dokumentation bis hin zu GitHub-Wikis, DokuWiki, PDFs und mehr. Unterstützte Plattformen sind CLI-basiert und funktionieren unter Unix und Windows (PowerShell). Der Workflow gliedert sich in Onboarding (Projektname, Quellverzeichnisse, Zielgruppe, Zielformat), Formatgenerierung (mithilfe von Agenten und Companion-Skripten), optionale Anreicherung mit GitHub-Issue/PR-Referenzen und schließlich Deployment. Es vereinfacht die Erstellung professioneller Dokumentation aus verteilten Spezifikationsdateien und bietet eine konsistente Schnittstelle für unterschiedlichste Ausgabeformate.

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

In Ihrer bevorzugten KI fragen

Öffnet einen neuen Chat, in dem dieser Agent-Skill bereits geladen ist.

Dokumentation

md-to-wiki — Dünner Router (Phase 2)

Verwandle Markdown-Spezifikationsdateien in Dokumentationsseiten.

Auslöser: „Wiki erstellen", „Dokumentation generieren", „Spezifikationen veröffentlichen", „Seite erstellen", „Wiki aus Markdown", „Diagramm zeichnen", „Flussdiagramm", „Architekturdiagramm", „Zustandsdiagramm", „Sequenzdiagramm"

Phasen-Router

Analysiere die Benutzeranfrage, um den passenden Pfad zu bestimmen:

lower=$(echo "$1" | tr '[:upper:]' '[:lower:]')
case "$lower" in
  *"not sure"*|*"help"*|*"recommend"*)     ROUTE="onboarding" ;;
  *"html"*|*"site"*|*"mkdocs"*|*"material"*)  ROUTE="mkdocs" ;;
  *"swagger"*|*"openapi"*|*"api"*)          ROUTE="swagger" ;;
  *"github wiki"*|*"wiki tab"*)             ROUTE="github-wiki" ;;
  *"dokuwiki"*|*"doku"*)                    ROUTE="dokuwiki" ;;
  *"pdf"*|*"print"*|*"book"*)               ROUTE="pdf" ;;
  *"reference"*|*"issue"*|*"pr"*|*"pull"*)  ROUTE="references" ;;
  *"deploy"*|*"publish"*|*"go live"*)       ROUTE="deploy" ;;
  *)                                          ROUTE="onboarding" ;;
esac

Starte dann den passenden Agenten:

RouteAgentBeschreibung
onboardingagents/onboarding.mdBenutzer befragen, Betriebssystem erkennen, SKILL_DIR einrichten
mkdocsagents/format-mkdocs.mdMkDocs-Material-Seite generieren
swaggeragents/format-swagger.mdOpenAPI 3.0 + Swagger UI generieren
github-wikiagents/format-github-wiki.mdIn GitHub-Wiki veröffentlichen
dokuwikiagents/format-dokuwiki.mdIn DokuWiki-Format konvertieren
pdfagents/format-pdf.mdPDF via Pandoc generieren
referencesagents/references.mdDokumentation mit GitHub-Issue/PR-Referenzen anreichern
deployagents/deploy.mdGenerierte Dokumentation bereitstellen

Ausführungsablauf

  1. Onboarding → Fragen stellen: Projektname, Quellverzeichnisse, Zielgruppe (Entwickler/Stakeholder/Allgemein), gewünschtes Format. Betriebssystem einmal erkennen, SKILL_DIR, SCRIPT_EXT, SCRIPT_RUNNER speichern.
  2. Formatgenerierung → Passenden Format-Agenten laden. Companion-Skripte aus scripts/ mit $SCRIPT_RUNNER verwenden.
  3. Referenzen → Falls gewünscht, references.md laden.
  4. Deployment → Nach der Generierung deploy.md laden, um Hosting anzubieten.

Globale Variablen (werden während des Onboardings einmal gesetzt)

  • SKILL_DIR — aufgelöster Pfad zu diesem Skill-Ordner
  • SCRIPT_EXT — .sh oder .ps1
  • SCRIPT_RUNNER — "" oder "powershell -File"
  • OS_TYPE — unix oder windows
  • PROJECT_NAME — vom Benutzer
  • SOURCES — Pfade zu Spezifikationsdateien
  • AUDIENCE — developer, stakeholder oder general

Companion-Skripte

Alle akzeptieren Positionsargumente identisch in .sh und .ps1:

SkriptZweck
discover-sourcesDurchsucht Verzeichnisse nach Spezifikations-/Projekt-/Codebasis-/Quick-Dateien
generate-mkdocsErstellt vollständige mkdocs.yml + Seitenstruktur
generate-indexBaut zielgruppengerechte Landingpage
to-dokuwikiKonvertiert Markdown → DokuWiki-Syntax
to-pdfVerkettet und konvertiert via pandoc zu PDF
fetch-issuesCached GitHub-Issue/PR-Metadaten

Multi-Verzeichnis-Eingabe

Mehrere Quellverzeichnisse vor der Ausführung in merged-specs/ zusammenführen:

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

Teilen

Kopiere md-to-wiki/ in den Ordner .config/opencode/skills/ oder .opencode/skills/ eines Kollegen. Abhängigkeiten variieren je nach Format.

Verwandte Skills