安装

其他安装命令

macOS

Homebrew已验证 · 100%

brew install docfx

local Homebrew formula metadata

Linux

Nix已验证 · 92%

nix profile install nixpkgs#docfx

nixpkgs package indexes · pkgs/by-name/do/docfx/package.nix · 来源: api.github.com

Windows

Chocolatey已验证 · 92%

choco install docfx

Chocolatey community package catalog · docfx · 来源: community.chocolatey.org

Scoop已验证 · 92%

scoop install main/docfx

Scoop official bucket manifest trees · bucket/docfx.json · 来源: api.github.com

概览

软件包摘要

Tools for building and publishing API documentation for .NET projects

项目链接

命令和别名

docfx

历史

项目历史与用法

DocFX is a static documentation generator best known for combining Markdown content with generated .NET API reference documentation.

Its story is tied to Microsoft documentation: it grew as an open-source documentation engine, was associated with Microsoft Docs and Microsoft Learn workflows, and later continued as a .NET Foundation/community-driven project after Microsoft Learn stopped using the public project.

项目历史

The GitHub release history reaches back to 2015-era 0.x releases, followed by a long 2.x line used by .NET projects for API docs and technical documentation sites.

DocFX's public identity emphasizes static-site generation plus API reference extraction for .NET, REST API documentation, landing pages, and Markdown documentation.

A later v3 branch was used internally for Microsoft Learn work, while public package notes and repository text state that Microsoft Learn no longer uses docfx and the project is planned to continue as community-driven under the .NET Foundation.

采用历史

DocFX was adopted by .NET library and platform projects because it could generate reference documentation from assemblies or source comments while hosting conceptual docs in the same site.

It is distributed through NuGet and packaged by Homebrew, Chocolatey, Scoop, and Nix, covering both developer-local and CI documentation builds.

使用方式

A typical project keeps a docfx.json config file, runs docfx metadata/build/serve commands, and publishes the generated static site to GitHub Pages, Azure Static Web Apps, or another static host.

The tool is especially useful when API reference and hand-written Markdown must cross-link in one documentation site.

为什么软件包爱好者会关心

DocFX is a major example of docs-as-code moving from bespoke vendor documentation systems into normal package-manager-installed CLI workflows.

Its Microsoft Learn transition is historically interesting because it left a widely used open-source tool with a community maintenance path after the largest original user moved on.

时间线

2015: early v0.x DocFX releases appeared on GitHub.
2016-2021: the 2.x release line matured into the common public DocFX generation path for .NET projects.
2018: Microsoft Learn's On .NET show introduced DocFX as an open-source static site generator for source-code and Markdown documentation.
2021-2022: v3 prerelease work existed, while public notes later said the v3 branch was privatized for Microsoft Learn.
2022 onward: Microsoft Learn stopped using the public docfx project and DocFX continued as a .NET Foundation/community-driven project.
2025-2026: the public 2.x line continues to receive compatibility and maintenance releases.

Related projects

Related documentation generators include Sandcastle, Doxygen, Sphinx, MkDocs, Docusaurus, Docsy, and Microsoft Learn's current internal documentation systems.
DocFX depends conceptually on .NET XML documentation comments, Roslyn metadata extraction, Markdown processing, templates, and static-site publishing workflows.

来源

安全态势

风险级别：绿色

narrow executable package without higher-risk signals.

风险分类器

绿色风险 · 低置信度 · appliance

原因

narrow executable package without higher-risk signals

信号

metadata:no-higher-risk-signals

安装行为

formula 元数据中未记录 Homebrew post-install 钩子。
Homebrew bottle 元数据适用于 6 个平台目标。
安装时包含 1 个运行时依赖。
构建元数据列出 1 个构建依赖。

建议审查

在无人值守的代理使用前，请检查该工具是否读取明文凭据、写入远程状态、发布制品或调用插件。

local files

Configuration and credential file locations

These source-backed paths show where this package keeps local settings or durable credentials. Automic Vault can use them as review targets for secret scanning, migration, and command approval.

Configuration files

Config paths the tool may read or write during local use.

Unix: ./docfx.json

可执行文件

已安装的可执行文件

命令	类型	暴露范围	备注
`docfx`	cli	全局可执行文件

新鲜度

版本和新鲜度

这些信号区分页生成时间、软件包管理器活动和上游发布比较。只有存在证据 URL 和可比较版本时，才会提示版本落后。

页面生成时间2026-07-25

管理器版本2.78.5

管理器更新时间

本地数据OK

上游当前

检测到的最新版本v2.78.5

https://github.com/dotnet/docfx

信息No package-manager update timestamp was available.低置信度

安装元数据

软件包元数据

软件包键	brew:docfx
版本	2.78.5
软件包管理器	Homebrew
软件包管理器页面	https://formulae.brew.sh/formula/docfx
主页	https://dotnet.github.io/docfx/
仓库	https://github.com/dotnet/docfx
上游文档	https://dotnet.github.io/docfx
许可证	MIT
源码归档	https://github.com/dotnet/docfx/archive/refs/tags/v2.78.5.tar.gz
依赖	dotnet
构建依赖	node
Bottle	可用 (于 arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, sonoma, x86_64_linux)
Homebrew post-install	未定义
服务	未声明

注册表事实

源数据库详情

Source Database	Homebrew formula API
Tap	homebrew/core
Full Name	docfx
Version Scheme	0
Revision	0
Bottle Stable Root URL	https://ghcr.io/v2/homebrew/core
Deprecated	no
Disabled	no
Keg Only	no
URL Keys	stable

源数据库匹配

其他软件包管理器记录

匹配项来自外部软件包管理器索引，并与本地 Automic Vault 软件包链接分开显示。

Nix95%

docfx

nix profile install nixpkgs#docfx

normalized package name match
匹配方式：Docfx

nixpkgs package indexes · api.github.com · nixpkgs package indexes: pkgs/by-name/do/docfx/package.nix from https://api.github.com/repos/NixOS/nixpkgs/git/trees/master?recursive=1

Chocolatey95%

docfx

choco install docfx

normalized package name match
匹配方式：Docfx

Chocolatey community package catalog · community.chocolatey.org · Chocolatey community package catalog: docfx from http://community.chocolatey.org/api/v2/Packages?$filter=IsLatestVersion&$select=Id&$top=1000&$skiptoken='11','dnspy'

Scoop95%

main/docfx

scoop install main/docfx

normalized package name match
匹配方式：Docfx

Scoop official bucket manifest trees · api.github.com · Scoop official bucket manifest trees: bucket/docfx.json from https://api.github.com/repos/ScoopInstaller/Main/git/trees/master?recursive=1

软件包图谱

链接来自本地软件包关系图、补充数据、依赖边、生态匹配和软件包 hub 归属。

来源线索

由仓库数据生成

此页面由 av-web 从 scripts/generate-pkg-sqlite.py 生成的私有软件包 SQLite 工件提供。

Combined YAML source

View the package source record on GitHub.

combined/docfx.yml

使用的来源

Geiger risk classifier
Nucleus package database
av.db category and tag curation
cross-ecosystem install command graph
curated configuration and credential file locations
curated package history
external package-manager database matches
package relationship graph
package version freshness
package-page enrichment

使用 Homebrew, chocolatey, Nix, scoop 安装 docfx