This repository contains a series of tools, templates, tips and tricks to make your DocFX life even better.

• TocDocFxCreation: generate a Table of Contents (TOC) in YAML format for DocFX. It has features like the ability to configure the order of files and the names of documents and folders.
• DocLinkChecker: validate links in documents and check for orphaned attachments in the .attachments folder. The tool indicates whether there are errors or warnings, so it can be used in a CI pipeline. It can also clean up orphaned attachments automatically.
• DocLanguageTranslator: allows to generate and translate automatically missing files or identify missing files in multi language pattern directories.

• Documentation validation pipeline: a sample pipeline to use the TocDocFxCreation for generating the table of contents and DocFx to generate a website. This sample will also publish to an Azure App Service.
• Documentation build pipeline: a sample pipeline to use markdownlint to validate markdown style and the DocLinkChecker to validate the links and attachments.

• Guidelines on how to use Markdownlint for your developers.
• Guidelines for creating Markdown docs for your developers. This contains patterns as well as tips and tricks.
• Guidelines for end user documentation for your developers.
• Specific elements to add and consider for proper usage and support for Mermaid.

Please read the main license file and the sub folder license files and 3rd party notice. Most of those tools are coming from a work done with ZF.