DocFx Companion Tools

Transformez un dossier de fichiers Markdown et de fichiers sources en documentation DocFX avec les utilitaires dans DocFx Companion Tools. Créé par Laurent Ellerbach et Martin Tirion, le paquet rassemble des outils pour préparer, organiser, vérifier, traduire et convertir la documentation ; sa version actuelle est 2.0.0.

DocFxTocGenerator examine une structure de dossiers contenant des fichiers MD et construit une table des matières correspondante pour la navigation de documentation. DocLinkChecker valide les liens et les pièces jointes référencés par les fichiers MD, aidant à identifier les références de documentation cassées pendant la préparation et l'examen.

DocLanguageTranslator traduit automatiquement les fichiers MD par Azure Cognitive Services, ajoutant la traduction au même flux de travail de documentation. DocFxOpenApi convertit les fichiers de spécifications OpenAPI existants en un format compatible avec DocFX, de sorte que les descriptions d'API peuvent être intégrées dans la documentation générée.

Les utilitaires conviennent aux développeurs, aux auteurs techniques et aux responsables de la documentation qui organisent le contenu Markdown, vérifient ses références, le traduisent ou connectent les spécifications de l'API à des projets DocFX. Un workflow typique peut utiliser la disposition du dossier pour créer la navigation, vérifier les liens et les pièces jointes, traiter les traductions et convertir le matériel OpenAPI avant de générer la documentation finale. Le paquet fonctionne sous Windows et est distribué sous forme de freeware.