macOS
Homebrewvérifié · 100%
brew install naturaldocslocal Homebrew formula metadata
MacPortsvérifié · 94%
sudo port install naturaldocsMacPorts ports tree · textproc/naturaldocs/Portfile · Source: api.github.com
brew
Installer naturaldocs avec Homebrew, apt, MacPorts, dnf
Consultez les chemins d'installation, exécutables, métadonnées et notes de sécurité de naturaldocs pour les workflows d'agents IA.
installation
Commandes d'installation supplémentaires
Linux
Debian aptvérifié · 92%
sudo apt install naturaldocsDebian stable package indexes · naturaldocs · Source: deb.debian.org
Fedora dnfvérifié · 92%
sudo dnf install NaturalDocsFedora Rawhide package metadata · NaturalDocs · Source: dl.fedoraproject.org
aperçu
Résumé du paquet
Extensible, multi-language documentation generator
Liens du projet
Commandes et alias
- naturaldocs
historique
Historique du projet et usages
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.
Historique du projet
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.
Historique d'adoption
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.
Modes d'utilisation
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.
Pourquoi les passionnés de paquets s'y intéressent
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.
Chronologie
- 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.
Sources
posture de sécurité
Niveau de risque : vert
narrow executable package without higher-risk signals.
Classificateur de risque
risque vert · confiance faible · appliance
Pourquoi
- narrow executable package without higher-risk signals
Signaux
- metadata:no-higher-risk-signals
Comportement d'installation
- Aucun hook post-install Homebrew n’est enregistré dans les métadonnées de formule.
- Les métadonnées de bottle Homebrew sont disponibles pour 1 plateformes.
- S’installe avec 1 dépendances d’exécution.
Revue recommandée
Avant une utilisation sans surveillance par un agent, vérifiez si l'outil lit des identifiants en clair, écrit un état distant, publie des artefacts ou lance des plugins.
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
exécutables
Exécutables installés
| Commande | Type | Exposition | Note |
|---|---|---|---|
naturaldocs | cli | exécutable global |
fraîcheur
Version et fraîcheur
Ces signaux séparent l'âge de génération de la page, l'activité du gestionnaire de paquets et la comparaison avec les versions amont. Un retard de version n'est signalé que lorsqu'une URL de preuve et des versions comparables sont présentes.
page générée2026-07-26
version du gestionnaire2.3.1
gestionnaire mis à jour
données localesOK
amontnot checked
dernière version détectéenon détecté
- infoNo package-manager update timestamp was available.confiance faible
- infoRelease/tag comparison is only available for GitHub repositories.https://www.naturaldocs.org/confiance none
métadonnées d'installation
Métadonnées du paquet
| Clé du paquet | brew:naturaldocs |
|---|---|
| Version | 2.3.1 |
| Gestionnaire de paquets | Homebrew |
| Page du gestionnaire de paquets | https://formulae.brew.sh/formula/naturaldocs |
| Page d'accueil | https://www.naturaldocs.org/ |
| Dépôt | https://github.com/NaturalDocs/NaturalDocs |
| Docs amont | https://www.naturaldocs.org/getting_started |
| Licence | AGPL-3.0-only |
| Archive source | https://downloads.sourceforge.net/project/naturaldocs/Stable%20Releases/2.3.1/Natural_Docs_2.3.1.zip |
| Dépendances | mono |
| Bouteille | disponible (sur all) |
| post-install Homebrew | non défini |
| Service | aucun déclaré |
faits du registre
Détails de la base source
| Source Database | Homebrew formula API |
|---|---|
| Tap | homebrew/core |
| Full Name | naturaldocs |
| Version Scheme | 0 |
| Revision | 0 |
| Bottle Stable Root URL | https://ghcr.io/v2/homebrew/core |
| Deprecated | no |
| Disabled | no |
| Keg Only | no |
| URL Keys |
|
correspondances dans les bases sources
Autres enregistrements de gestionnaires de paquets
Les correspondances proviennent d’index externes de gestionnaires de paquets et restent séparées des liens de paquets Automic Vault locaux.
Debian apt95%
naturaldocs 1.51-4
extensible, multi-language documentation generator
sudo apt install naturaldocs- Section: devel
- Architecture: all
- 1 Dépendances
- normalized package name match
- Correspondance par : 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 Dépendances
- normalized package name match
- Correspondance par : Naturaldocs
dnf95%
NaturalDocs 1.52-36.fc44
Documentation generator for multiple programming languages
sudo dnf install NaturalDocs- License: GPL-2.0-or-later
- Category: Unspecified
- Architecture: noarch
- Source Package: NaturalDocs
- 3 Dépendances
- 3 fournit
- normalized package name match
- Correspondance par : Naturaldocs
MacPorts95%
naturaldocs
sudo port install naturaldocs- normalized package name match
- Correspondance par : Naturaldocs
piste source
Généré depuis les données du dépôt
Cette page est servie par av-web depuis l'artéfact SQLite privé des paquets généré par scripts/generate-pkg-sqlite.py.
Combined YAML source
View the package source record on GitHub.
Sources utilisées
- 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