Description:
Tools for building and publishing API documentation for .NET projects
|
|
Type: Formula
|
Latest Version: 2.78.4@0
|
Tracked Since: Dec 17, 2025
|
|
Links:
Homepage |
@dotnet |
formulae.brew.sh
|
|
Category: Developer tools
|
|
Tags:
documentation
dotnet
api-reference
static-site
developer-tools
|
|
Install:
brew install docfx
|
About:
DocFX is a command-line tool and static site generator designed specifically for creating API reference documentation from .NET assemblies and C# source code. It processes triple-slash comments and XML doc files to produce professional, searchable documentation sites. The tool supports multiple output formats including HTML and Markdown, making it ideal for continuous integration pipelines.
|
Key Features:
- API reference generation from .NET assemblies and source code
- Support for multiple documentation formats including Markdown and REST API specs
- Extensible plugin architecture for customizing build pipelines
- Built-in search functionality and responsive HTML templates
- Integration with CI/CD workflows for automated publishing
|
Use Cases:
- Generating API documentation for .NET libraries and frameworks
- Creating internal technical documentation portals for development teams
- Publishing public-facing documentation sites for open-source projects
- Building comprehensive documentation sites that combine API references with conceptual articles
|
Alternatives:
-
Sandcastle
– DocFX is more modern, faster, and supports Markdown, while Sandcastle is older and more complex to configure
-
Doxygen
– Doxygen supports multiple languages but DocFX provides better .NET-specific features and modern output templates
-
Wyam
– Wyam is a general static site generator, whereas DocFX is purpose-built for API documentation
|
|
License: MIT
|
|
Dependencies: dotnet
|
|
Bottles available for: arm64_tahoe, arm64_sequoia, arm64_sonoma, arm64_linux, x86_64_linux
|
| Detected |
Version |
Rev |
Change |
Commit |
| Oct 24, 2025 7:59am |
|
0 |
VERSION_BUMP |
4e70c7ae |
| Sep 15, 2025 3:42am |
|
0 |
VERSION_BUMP |
3bd10e3b |
| Nov 18, 2024 3:31pm |
|
0 |
VERSION_BUMP |
8528b6ec |
| Sep 26, 2024 9:22pm |
|
0 |
VERSION_BUMP |
31df6ff0 |
| Oct 18, 2023 3:51pm |
|
0 |
VERSION_BUMP |
9b18723b |
| Sep 4, 2023 11:38pm |
|
0 |
VERSION_BUMP |
e67d9cbf |
| Mar 20, 2023 10:06am |
|
0 |
VERSION_BUMP |
1c1d544b |
| Mar 20, 2023 10:06am |
|
0 |
VERSION_BUMP |
9e528810 |
| Mar 9, 2023 4:06am |
|
0 |
VERSION_BUMP |
61372c52 |
| Mar 9, 2023 4:06am |
|
0 |
VERSION_BUMP |
388e5e7b |
| Mar 8, 2023 12:37pm |
|
0 |
VERSION_BUMP |
9079a5cc |
| Mar 8, 2023 12:37pm |
|
0 |
VERSION_BUMP |
49ab3bf7 |
|