Build your technical documentation site with docfx. Converts .NET assembly, XML code comment, REST API Swagger files and markdown into rendered HTML pages, JSON model or PDF files.

Docfx shows only the public accessible types and methods callable from another assembly. It also has a set of default filtering rules that excludes common API patterns based on attributes such as …

Docfx is a command-line tool that can be invoked directly, or as a .NET Core CLI tool using the dotnet command, but it can also be invoked from source code using the Docset.Build method in the Docfx …

Docfx supports CommonMark for writing conceptual files. DFM supports all Github Flavored Markdown (GFM) syntax with 2 exceptions when resolving list. It also adds several new features including file …

Run docfx --help or docfx -h to get a list of all available commands and options. Run docfx <command> --help or docfx <command> -h to get help on a specific command.

Docfx produces a sitemap.xml about the pages on your site for search engines like Google to crawl your site more efficiently. The sitemap option in docfx.json controls how sitemaps are generated:

Besides creating links using file path, docfx supports links to another resource identified by ID. This is useful for cases where you want to create path-independent references or share resources between …

Docfx produces the right git links for major CI pipelines including GitHub, GitLab, Azure Pipelines, AppVeyor, TeamCity, Jenkins. _gitContribute and _gitUrlPattern are optional on these platforms.

Specifies the output folder of the generated metadata files relative to docfx.json directory. The docfx metadata --output <outdir> command line argument overrides this value.

DocFX allows you to customize the display of alert titles in your documentation. By default, alert titles are displayed as the keyword in upper case. To change this behavior, you can create a custom …