DocFx Companion Tools

DocFx Companion Tools est un logiciel Windows contenant des utilitaires pour générer de la documentation à partir de fichiers Markdown et de fichiers sources avec DocFX. Son champ d'application couvre plusieurs tâches connexes utilisées pour préparer, organiser, vérifier, traduire et convertir les documents. Il est destiné aux personnes qui travaillent avec des fichiers MD et doivent les utiliser dans le cadre d'un workflow de documentation DocFX.

DocFxTocGenerator crée une table des matières à partir d'une structure de dossiers contenant des fichiers MD. Ceci utilise l'organisation de fichiers de documentation pour générer les informations de navigation correspondantes. DocLinkChecker valide les liens et les pièces jointes utilisés dans les fichiers MD, permettant de vérifier ces références dans le cadre du processus de documentation.

DocLanguageTranslator traduit automatiquement les fichiers MD par Azure Cognitive Services. Cela place la traduction dans le même ensemble d'utilitaires tout en conservant les fichiers MD comme le matériel en cours de traitement. DocFxOpenApi convertit les fichiers de spécifications OpenAPI existants en un format compatible avec DocFX, connectant les spécifications API à la documentation basée sur DocFX.

En tant qu'entrée Windows dans un catalogue de téléchargement, DocFx Companion Tools s'adapte aux workflows de documentation construits autour de DocFX, fichiers Markdown, fichiers sources et spécifications OpenAPI. La licence du logiciel est inconnue, de sorte que l'entrée du catalogue n'établit pas de termes d'utilisation ou de redistribution. MirrorNest se connecte directement à la version officielle plutôt que de refléter le logiciel, donnant aux lecteurs accès à travers la source de publication.