Skip to content
SPECIFICTION
Get listed

DocFX vs Natural Docs

DocFX

dotnet.github.io

Natural Docs

naturaldocs.org

Side by side

FigureDocFXNatural Docs
Price fromFreeFree
Free planYesYes
Free trial——
Open source——
WindowsYesYes
macOSYesYes
LinuxYesYes
APIYes—
Self-hostedYes—
Plans published11
Spec score · Documentation Generators8.2 (#6)7.7 (#15)
CustomizationUsers can customize templates with CSS, JavaScript, Mustache templates, and metadata settings.The generated output can be styled with custom CSS and images.
PurposeDocFX builds technical documentation sites from .NET assemblies, XML code comments, REST API Swagger files, and Markdown.Natural Docs is an open source documentation generator that scans code comments and creates HTML documentation.
SupportThe DocFX project is listed as supported by the .NET Foundation.Help is available through the Reddit forum, email to the author, and GitHub issue tracker; businesses can contact the author about commercial support contracts.

Plans

DocFX

  • DocFXFree

DocFX pricing →

Natural Docs

  • Natural DocsFree

Natural Docs pricing →

In their own words

DocFX

DocFX is a free static site generator for technical documentation. It builds documentation from .NET assemblies, XML code comments, REST API Swagger files and Markdown, and can produce rendered HTML pages, JSON models or PDFs. Static HTML output is placed in the `_site` folder for publication to hosting services such as GitHub Pages. DocFX can also be used as a NuGet library through the `Docfx.App` package and .NET APIs. It parses CommonMark-compliant Markdown with Markdig and supports additional extensions. Built-in templates include a modern option with dark mode and customization settings; users can also customize templates with CSS, JavaScript, Mustache templates and metadata. DocFX can generate git links for GitHub, GitLab, Azure Pipelines, AppVeyor, TeamCity and Jenkins. It requires .NET SDK 8.0 or higher. Node.js v20 or higher is optional generally, but required to create PDFs. Native reference documentation generation covers .NET and REST APIs; other languages need a custom API docs converter. PlantUML diagrams use a remote server by default, with local rendering available as a setting.

Visit dotnet.github.io

Natural Docs

Natural Docs is a command-line documentation generator that scans source-code comments and text files to create HTML documentation, including API references. Its syntax is designed to read like ordinary English in both source code and generated pages. The project says it comes configured for 25 programming languages and can be extended; for certain languages, it can also read Javadoc and Microsoft XML comments without rewrites. Generated pages have three panels, dynamic navigation, search and summaries that appear when readers hover over links. They can be opened from a local hard drive without installed software, and styled with custom CSS and images. Natural Docs runs on Linux, macOS and Windows. It is free and open source under AGPL version 3. The license requires source availability for modified distributions, projects incorporating its source, and services incorporating its functionality; merely documenting a project does not place that project under AGPL. Help is available through a Reddit forum, email and GitHub issues, with commercial support contracts available to businesses.

Visit naturaldocs.org