macOS
Homebrew已验证 · 100%
brew install naturaldocslocal Homebrew formula metadata
MacPorts已验证 · 94%
sudo port install naturaldocsMacPorts ports tree · textproc/naturaldocs/Portfile · 来源: api.github.com
安装
其他安装命令
Linux
Debian apt已验证 · 92%
sudo apt install naturaldocsDebian stable package indexes · naturaldocs · 来源: deb.debian.org
Fedora dnf已验证 · 92%
sudo dnf install NaturalDocsFedora Rawhide package metadata · NaturalDocs · 来源: dl.fedoraproject.org
概览
软件包摘要
Extensible, multi-language documentation generator
历史
项目历史与用法
Natural Docs is a multi-language source-code documentation generator built around comments that stay readable in the source file. Its niche is documentation that feels closer to prose than annotation syntax, while still producing browsable HTML output.
项目历史
The official About page says Greg Valure wrote Natural Docs after rejecting heavier documentation workflows, open sourced it, and has maintained it since its first release in 2003. The same page records the major architectural shift from the original Perl implementation to Natural Docs 2.0, a C# rewrite with a new engine.
The GitHub repository for the 2.x code was created on 2017-04-17. Public GitHub releases include Natural Docs 2.3 on 2023-09-12, 2.3.1 on 2025-02-01, and 2.4 beta work in 2026.
采用历史
Natural Docs has a long tail rather than a large modern package-manager footprint. The official site says it is used by educational institutions, government, companies, and individuals, and points to public pages generated by Natural Docs as evidence. Homebrew analytics consulted on 2026-07-01 listed 113 installs over the preceding 365 days.
使用方式
Users configure a project with `Project.txt`, which tells Natural Docs which source folders to scan, where to write generated documentation, and project metadata such as title. The reference documentation says command-line options can override parts of Project.txt, partly for compatibility with Natural Docs 1.x workflows.
为什么软件包爱好者会关心
Natural Docs is interesting to package maintainers because it spans two eras of language tooling: old Perl-era source documentation and the 2.x C#/Mono packaging story. The Homebrew formula still depends on Mono, which makes it a reminder that documentation generators often carry runtime packaging constraints long after their core idea stabilizes.
时间线
- 2003: First Natural Docs release, according to the official About page.
- 2015-05-04: Natural Docs 2.0 development release tag appears in the GitHub repository.
- 2017-04-17: GitHub repository created for the 2.x source tree.
- 2023-09-12: Natural Docs 2.3 released.
- 2025-02-01: Natural Docs 2.3.1 released.
- 2026-05-26: Natural Docs 2.4 Beta 1 released as a prerelease.
Related projects
- Comparable documentation generators include Doxygen, Javadoc-style tooling, Sphinx, and language-native documentation systems, but Natural Docs' distinguishing feature is its plain-English comment style.
来源
安全态势
风险级别：绿色
narrow executable package without higher-risk signals.
风险分类器
绿色 风险 · 低 置信度 · appliance
原因
- narrow executable package without higher-risk signals
信号
- metadata:no-higher-risk-signals
安装行为
- 未记录 Homebrew bottle 元数据。
建议审查
在无人值守的代理使用前，请检查该工具是否读取明文凭据、写入远程状态、发布制品或调用插件。
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
Project.txt in the project configuration folder
可执行文件
已安装的可执行文件
| 命令 | 类型 | 暴露范围 | 备注 |
|---|---|---|---|
naturaldocs | 可执行文件 | 已索引可执行文件 | 从本地可执行文件索引发现。 |
新鲜度
版本和新鲜度
这些信号区分页生成时间、软件包管理器活动和上游发布比较。只有存在证据 URL 和可比较版本时，才会提示版本落后。
页面生成时间2026-08-03
管理器版本2.3.1
管理器更新时间2026-07-27
本地数据未知
上游不可用
检测到的最新版本未检测到
- OK没有生成新鲜度警告。
安装元数据
软件包元数据
| 软件包键 | brew:naturaldocs |
|---|---|
| 版本 | 2.3.1 |
| 软件包管理器 | Homebrew |
| 主页 | https://www.naturaldocs.org/ |
| 仓库 | https://github.com/NaturalDocs/NaturalDocs |
| 最后更新 | 2026-07-27T12:14:49-04:00 |
| Pulse | updated |
| Bottle | 未记录 |
| 服务 | 未声明 |
源数据库匹配
其他软件包管理器记录
匹配项来自外部软件包管理器索引，并与本地 Automic Vault 软件包链接分开显示。
Debian apt95%
naturaldocs 1.51-4
extensible, multi-language documentation generator
sudo apt install naturaldocs- Section: devel
- Architecture: all
- 1 依赖
- normalized package name match
- 匹配方式：Naturaldocs
Ubuntu apt95%
naturaldocs 1:1.5.1-0ubuntu1
an extensible, multi-language documentation generator
sudo apt install naturaldocs- Section: universe/devel
- Architecture: all
- 1 依赖
- normalized package name match
- 匹配方式：Naturaldocs
dnf95%
NaturalDocs 1.52-37.fc45
Documentation generator for multiple programming languages
sudo dnf install NaturalDocs- License: GPL-2.0-or-later
- Category: Unspecified
- Architecture: noarch
- Source Package: NaturalDocs
- 3 依赖
- 3 提供
- normalized package name match
- 匹配方式：Naturaldocs
MacPorts95%
naturaldocs
sudo port install naturaldocs- normalized package name match
- 匹配方式：Naturaldocs
来源线索
由仓库数据生成
此页面由 av-web 从 scripts/generate-pkg-sqlite.py 生成的私有软件包 SQLite 工件提供。
Combined YAML source
View the package source record on GitHub.
使用的来源
- Geiger risk classifier
- cross-ecosystem install command graph
- curated configuration and credential file locations
- curated package history
- external package-manager database matches
- pkg.so package database
- pkgdb category and tag curation