DocFx Companion Tools

Trasformare una cartella di file Markdown e file sorgente in documentazione DocFX con le utility in DocFx Companion Tools. Creato da Laurent Ellerbach e Martin Tirion, il pacchetto riunisce strumenti per preparare, organizzare, controllare, tradurre e convertire la documentazione; la sua versione attuale è 2.0.0.

DocFxTocGenerator esamina una struttura della cartella contenente i file MD e costruisce una tabella corrispondente dei contenuti per la navigazione della documentazione. DocLinkChecker convalida i link e gli allegati richiamati dai file MD, aiutando a identificare i riferimenti di documentazione rotti durante la preparazione e la revisione.

DocLanguageTranslator traduce automaticamente i file MD attraverso Azure Cognitive Services, aggiungendo la traduzione allo stesso flusso di lavoro di documentazione. DocFxOpenApi converte i file di specificazione OpenAPI esistenti in un formato compatibile con DocFX, così le descrizioni API possono essere incorporate nella documentazione generata.

Le utility si adattano agli sviluppatori, agli scrittori tecnici e ai manutentori di documentazione che organizzano il contenuto di Markdown, controllano i suoi riferimenti, lo traducono o collegano le specifiche API con i progetti DocFX. Un flusso di lavoro tipico può utilizzare il layout della cartella per creare la navigazione, verificare collegamenti e allegati, elaborare traduzioni e convertire materiale OpenAPI prima di generare la documentazione finale. Il pacchetto viene eseguito su Windows ed è distribuito come freeware.