Communitygithub.com

abertanha/md-to-wiki-docs-skills

Transforme arquivos de especificação em markdown em sites de documentação.

O que é md-to-wiki-docs-skills?

Esta skill (agente) converte arquivos de especificação em markdown em sites de documentação completos, suportando múltiplos formatos como MkDocs Material, Swagger UI para APIs, GitHub Wiki, DokuWiki, PDF via Pandoc e enriquecimento com referências de issues/PRs do GitHub. Ela utiliza um roteador de fases que analisa a solicitação do usuário (por exemplo, "build wiki", "generate docs", "publish specs", "draw diagram") e direciona para o agente apropriado. Durante a execução, há uma fase de onboarding que coleta informações do projeto (nome, diretórios fonte, público-alvo e formato desejado), configura variáveis globais (como SKILL_DIR, OS_TYPE, SCRIPT_EXT) e, em seguida, aciona scripts complementares (como discover-sources, generate-mkdocs, generate-index, to-dokuwiki, to-pdf, fetch-issues) para gerar o site final. Também oferece opção de implantação e suporte a múltiplos diretórios de entrada, mesclando-os antes da geração. A skill é compatível com Claude Code, Cursor, Codex e outras ferramentas que seguem o formato de skill descrito por SKILL.md.

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

Perguntar na sua IA favorita

Abre um novo chat com esta habilidade de agente já pré-carregada.

Documentação

md-to-wiki — Roteador Fino (Fase 2)

Transforme arquivos de especificação em markdown em sites de documentação.

Gatilhos: "build wiki", "generate docs", "publish specs", "make a site", "wiki from markdown", "draw diagram", "flow chart", "architecture diagram", "state diagram", "sequence diagram"

Roteador de Fase

Analise a solicitação do usuário para determinar qual caminho seguir:

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

Em seguida, lance o agente apropriado:

RotaAgenteDescrição
onboardingagents/onboarding.mdEntreviste o usuário, detecte o SO, configure SKILL_DIR
mkdocsagents/format-mkdocs.mdGere site MkDocs Material
swaggeragents/format-swagger.mdGere OpenAPI 3.0 + Swagger UI
github-wikiagents/format-github-wiki.mdPublique no GitHub Wiki
dokuwikiagents/format-dokuwiki.mdConverta para formato DokuWiki
pdfagents/format-pdf.mdGere PDF via Pandoc
referencesagents/references.mdEnriqueça a documentação com referências de issues/PRs do GitHub
deployagents/deploy.mdImplante a documentação gerada em um servidor de hospedagem

Fluxo de Execução

  1. Onboarding → Faça perguntas: nome do projeto, diretórios fonte, público-alvo (desenvolvedor/interessado/geral), formato desejado. Detecte o SO uma vez, armazene SKILL_DIR, SCRIPT_EXT, SCRIPT_RUNNER.
  2. Geração de formato → Carregue o agente de formato apropriado. Use scripts complementares de scripts/ com $SCRIPT_RUNNER.
  3. Referências → Se o usuário quiser referências de issues/PRs, carregue references.md.
  4. Implantação → Após a geração, carregue deploy.md para oferecer hospedagem.

Variáveis Globais (definidas uma vez durante o onboarding)

  • SKILL_DIR — caminho resolvido para a pasta desta skill
  • SCRIPT_EXT — .sh ou .ps1
  • SCRIPT_RUNNER — "" ou "powershell -File"
  • OS_TYPE — unix ou windows
  • PROJECT_NAME — do usuário
  • SOURCES — caminhos para arquivos de especificação
  • AUDIENCE — developer, stakeholder ou general

Scripts Complementares

Todos aceitam argumentos posicionais de forma idêntica em .sh e .ps1:

ScriptPropósito
discover-sourcesVarre diretórios em busca de arquivos de especificação/projeto/código-base/rápidos
generate-mkdocsCria mkdocs.yml completo + estrutura de páginas
generate-indexConstrói página inicial adequada ao público-alvo
to-dokuwikiConverte markdown → sintaxe DokuWiki
to-pdfConcatena + converte para PDF via pandoc
fetch-issuesArmazena em cache metadados de issues/PRs do GitHub

Entrada com Múltiplos Diretórios

Mescle múltiplos diretórios fonte em merged-specs/ antes de executar:

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

Compartilhamento

Copie md-to-wiki/ para a pasta .config/opencode/skills/ ou .opencode/skills/ do colega. As dependências variam conforme o formato.

Habilidades Relacionadas