Table of Contents

Tools

DocFxTocGenerator
DocFxTocGenerator

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. This tool is part of the DocFx Companion Tools set that can be installed using Chocolatey.

docfx: TocGenerator -d <docs folder> [-o <output folder>] [-vsi]
docfx init: git clone https://github.com/Ellerbach/docfx-companion-tools.git
DocLinkChecker
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. This tool is part of the DocFx Companion Tools set that can be installed using Chocolatey.

docfx: DocLinkChecker -d <docs folder> [-vac]
docfx init: git clone https://github.com/Ellerbach/docfx-companion-tools.git
DocLanguageTranslator
DocLanguageTranslator

Allows to generate and translate automatically missing files or identify missing files in multi language pattern directories. This tool is part of the DocFx Companion Tools set that can be installed using Chocolatey.

docfx: DocLanguageTranslator -d <docs folder> [-k <key>] [-l <location>] [-cv]
docfx init: git clone https://github.com/Ellerbach/docfx-companion-tools.git
DocFx Quick Start
DocFx Quick Start

A repo containing documentation, configuration and sample pipelines to help you get started quickly with DocFx. The Quick Start can be used as a reference or to copy elements from it to your own repo. The Quick Start itself can be generated to a website using DocFx as well. It uses the DocFx Companion Tools DocFxTocGenerator and DocLinkChecker.

docfx init: git clone https://github.com/mtirionMSFT/DocFxQuickStart.git
Addin for Cake Build System
Addin for Cake Build System

Cake AddIn that generates documentation for .Net API reference and markdown files using DocFx.