DocFx Companion Tools

Convierta una carpeta de archivos Markdown y archivos fuente en la documentación DocFX con las utilidades en DocFx Companion Tools. Creado por Laurent Ellerbach y Martin Tirion, el paquete reúne herramientas para preparar, organizar, revisar, traducir y convertir documentación; su versión actual es 2.0.0.

DocFxTocGenerator examina una estructura de carpetas que contiene archivos MD y construye una tabla de contenido coincidente para la navegación de la documentación. DocLinkChecker valida enlaces y archivos adjuntos referenciados por archivos MD, ayudando a identificar referencias de documentación rota durante la preparación y revisión.

DocLanguageTranslator traduce automáticamente archivos MD a través de Azure Cognitive Services, agregando traducción al mismo flujo de trabajo de documentación. DocFxOpenApi convierte los archivos de especificación OpenAPI existentes en un formato compatible con DocFX, por lo que las descripciones de API se pueden incorporar en la documentación generada.

Las utilidades se adaptan a desarrolladores, escritores técnicos y mantenedores de documentación que organizan el contenido de Markdown, comprueban sus referencias, lo traducen o conectan las especificaciones de API con proyectos DocFX. Un flujo de trabajo típico puede utilizar el diseño de carpetas para crear navegación, verificar enlaces y archivos adjuntos, procesar traducciones, y convertir el material OpenAPI antes de generar la documentación final. El paquete se ejecuta en Windows y se distribuye como freeware.