Automic VaultAutomic Vault

brew

docfx を Homebrew, chocolatey, Nix, scoop でインストール

docfx のインストール経路、実行ファイル、メタデータ、AI エージェント向けセキュリティノートを確認します。

インストールコマンドセキュリティノート

インストール

追加のインストールコマンド

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

概要

パッケージ概要

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

実行可能ファイル

インストールされる実行可能ファイル

コマンド種類公開範囲メモ
docfxcliグローバル実行可能ファイル

鮮度

バージョンと鮮度

これらの信号は、ページ生成時期、パッケージマネージャの活動、上流リリース比較を分けて示します。バージョン遅れは、証拠 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 DatabaseHomebrew formula API
Taphomebrew/core
Full Namedocfx
Version Scheme0
Revision0
Bottle Stable Root URLhttps://ghcr.io/v2/homebrew/core
Deprecatedno
Disabledno
Keg Onlyno
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

パッケージグラフ

リンクは、ローカルのパッケージ関係グラフ、補足データ、依存関係、エコシステム一致、パッケージハブ所属から来ています。

関連ツール

  • dotnetRuntime dependency declared by Homebrew.
  • nodeBuild dependency declared by Homebrew.

同じワークフロー

  • docmdShares av.db curated category or tags: cli, developer-tools, documentation, markdown, static-site-generator.
  • mdbookShares av.db curated category or tags: cli, developer-tools, documentation, markdown, static-site-generator.
  • action-docsShares av.db curated category or tags: cli, developer-tools, documentation, markdown.
  • bladesShares av.db curated category or tags: cli, developer-tools, markdown, static-site-generator.
  • doxygenShares av.db curated category or tags: api-docs, cli, developer-tools, documentation.
  • eleventyShares av.db curated category or tags: cli, developer-tools, markdown, static-site-generator.

エージェント安全ガイド

ソース経路

リポジトリデータから生成

このページは scripts/generate-pkg-sqlite.py が生成した非公開のパッケージ SQLite アーティファクトから av-web によって提供されます。

使用ソース

  • 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