DocFx Companion Tools

Transforme uma pasta de arquivos Markdown e arquivos fonte em documentação DocFX com os utilitários no DocFx Companion Tools. Criado por Laurent Ellerbach e Martin Tirion, o pacote reúne ferramentas para preparar, organizar, verificar, traduzir e converter documentação; sua versão atual é 2.0.0.

DocFxTocGenerator examina uma estrutura de pastas contendo arquivos MD e constrói uma tabela de conteúdo correspondente para navegação de documentação. O DocLinkChecker valida links e anexos referenciados por arquivos MD, ajudando a identificar referências de documentação quebradas durante a preparação e revisão.

DocLanguageTranslator traduz automaticamente arquivos MD através de Azure Cognitive Services, adicionando tradução para o mesmo fluxo de trabalho de documentação. DocFxOpenApi converte arquivos de especificação OpenAPI existentes em um formato compatível com DocFX, para que descrições API podem ser incorporadas em documentação gerada.

Os utilitários atendem desenvolvedores, escritores técnicos e mantenedores de documentação que organizam conteúdo Markdown, verificam suas referências, traduzem ou conectam especificações de API com projetos DocFX. Um fluxo de trabalho típico pode usar o layout da pasta para criar navegação, verificar links e anexos, traduzir processos e converter material OpenAPI antes de gerar a documentação final. O pacote é executado no Windows e é distribuído como freeware.