DocFx Companion Tools

Verwandeln Sie einen Ordner mit Markdown-Dateien und Quelldateien in die DocFX-Dokumentation mit den Dienstprogrammen in DocFx Companion Tools. Das von Laurent Ellerbach und Martin Tirion erstellte Paket vereint Werkzeuge zur Vorbereitung, Organisation, Überprüfung, Übersetzung und Konvertierung von Dokumentation; die aktuelle Version ist 2.0.0.

DocFxTocGenerator untersucht eine Ordnerstruktur mit MD-Dateien und erstellt ein passendes Inhaltsverzeichnis für die Dokumentationsnavigation. DocLinkChecker validiert Links und Anhänge, auf die in MD-Dateien verwiesen wird, und hilft dabei, fehlerhafte Dokumentationsreferenzen während der Vorbereitung und Überprüfung zu identifizieren.

DocLanguageTranslator übersetzt MD-Dateien automatisch über Azure Cognitive Services und fügt dem gleichen Dokumentationsworkflow eine Übersetzung hinzu. DocFxOpenApi konvertiert bestehende OpenAPI-Spezifikationsdateien in ein mit DocFX kompatibles Format, sodass API-Beschreibungen in die generierte Dokumentation integriert werden können.

Die Dienstprogramme passen zu Entwicklern, technischen Autoren und Dokumentationsbetreuern, die Markdown-Inhalte organisieren, ihre Referenzen überprüfen, sie übersetzen oder API-Spezifikationen mit DocFX-Projekten verbinden. Ein typischer Workflow kann das Ordnerlayout verwenden, um Navigation zu erstellen, Links und Anhänge zu überprüfen, Übersetzungen zu verarbeiten und OpenAPI-Material zu konvertieren, bevor die endgültige Dokumentation erstellt wird. Das Paket läuft unter Windows und wird als Freeware vertrieben.