DocFx Companion Tools

DocFx Companion Tools ist ein Windows-Softwarepaket, das Dienstprogramme zum Erstellen von Dokumentationen aus Markdown-Dateien und Quelldateien mit DocFX enthält. Sein Umfang umfasst mehrere verwandte Aufgaben, die bei der Vorbereitung, Organisation, Überprüfung, Übersetzung und Konvertierung von Dokumentationsmaterial verwendet werden. Es ist für Personen gedacht, die mit MD-Dateien arbeiten und diese als Teil eines DocFX-Dokumentationsworkflows verwenden müssen.

DocFxTocGenerator erstellt ein Inhaltsverzeichnis aus einer Ordnerstruktur, die MD-Dateien enthält. Diese nutzt die Organisation von Dokumentationsdateien, um entsprechende Navigationsinformationen zu generieren. DocLinkChecker validiert Links und Anhänge, die in MD-Dateien verwendet werden, so dass diese Referenzen im Rahmen des Dokumentationsprozesses überprüft werden können.

DocLanguageTranslator übersetzt MD-Dateien automatisch über Azure Cognitive Services. Dies stellt die Übersetzung in den gleichen Satz von Dienstprogrammen, während MD-Dateien als das Material verarbeitet werden. DocFxOpenApi konvertiert bestehende OpenAPI-Spezifikationsdateien in ein mit DocFX kompatibles Format und verbindet API-Spezifikationen mit DocFX-basierter Dokumentation.

Als Windows-Eintrag in einem Download-Katalog passt DocFx Companion Tools zu Dokumentationsworkflows, die auf DocFX, Markdown-Dateien, Quelldateien und OpenAPI-Spezifikationen basieren. Die Lizenz für die Software ist unbekannt, so dass der Katalogeintrag keine Nutzungs- oder Weiterverteilungsbedingungen festlegt. MirrorNest verlinkt direkt auf die offizielle Version, anstatt die Software zu spiegeln, sodass die Leser über die Release-Quelle Zugriff haben.