DocFx Companion Tools

DocFx Companion Tools é um pacote de software Windows contendo utilitários para gerar documentação de arquivos Markdown e arquivos de origem com DocFX. Seu escopo abrange várias tarefas relacionadas usadas na preparação, organização, verificação, tradução e conversão de material de documentação. Destina-se a pessoas que trabalham com arquivos MD e precisam usá-los como parte de um fluxo de trabalho de documentação DocFX.

DocFxTocGenerator cria uma tabela de conteúdo de uma estrutura de pastas contendo arquivos MD. Isso usa a organização de arquivos de documentação para gerar informações de navegação correspondentes. O DocLinkChecker valida links e anexos usados em arquivos MD, permitindo que essas referências sejam verificadas como parte do processo de documentação.

DocLanguageTranslator traduz automaticamente arquivos MD através de Azure Cognitive Services. Isto coloca a tradução dentro do mesmo conjunto de utilitários, mantendo arquivos MD como o material que está sendo processado. DocFxOpenApi converte arquivos de especificação OpenAPI existentes em um formato compatível com DocFX, conectando especificações de API com documentação baseada em DocFX.

Como uma entrada do Windows em um catálogo de download, DocFx Companion Tools se adapta aos fluxos de trabalho de documentação construídos em torno de DocFX, arquivos Markdown, arquivos de origem e especificações OpenAPI. A licença para o software é desconhecida, então a entrada do catálogo não estabelece termos para uso ou redistribuição. O MirrorNest liga diretamente ao lançamento oficial em vez de espelhar o software, dando aos leitores acesso através da fonte de lançamento.