macOS
Homebrewvérifié · 100%
brew install sourcedocslocal Homebrew formula metadata
brew
Installer sourcedocs avec Homebrew
Consultez les chemins d'installation, exécutables, métadonnées et notes de sécurité de sourcedocs pour les workflows d'agents IA.
installation
Commandes d'installation supplémentaires
aperçu
Résumé du paquet
Generate Markdown files from inline source code documentation
Liens du projet
Commandes et alias
- sourcedocs
historique
Historique du projet et usages
SourceDocs is a Swift command-line documentation generator that writes Markdown reference documentation from inline source comments, targeting repositories that want docs to live beside their code.
Historique du projet
The GitHub repository was created in October 2017, with the changelog marking 0.1.0 as the initial release. Early releases refined output directories, Markdown generation, and command-line behavior.
The 1.0.0 release added `SourceDocsLib` so other Swift tools could generate documentation, required Swift 5.1 or higher, added a `package` command for Swift packages, and migrated to Swift Argument Parser. Later 1.x and 2.x releases tracked Swift, Xcode, and package-generation changes.
Historique d'adoption
The README positions SourceDocs alongside Sphinx and Jazzy, but with a Markdown-in-repository model intended for GitHub, Bitbucket, and GitHub Pages workflows. It is distributed through Homebrew and source builds.
Modes d'utilisation
Users run `sourcedocs generate` from a Swift package or Xcode project root. The tool can generate documentation for all Swift Package Manager modules, a named module, package descriptions, and reproducible docs.
Pourquoi les passionnés de paquets s'y intéressent
Package nerds care because SourceDocs treats generated API docs as versioned Markdown artifacts rather than as an external hosted site. That makes it fit package repositories, CI diffs, and lightweight documentation publishing.
Chronologie
- 2017: Repository created and 0.1.0 initial release published.
- 2017: 0.4.0 changed default output to `Documentation/Reference` and revised command-line handling.
- 2020: 1.0.0 added `SourceDocsLib`, Swift 5.1 requirement, Swift Package documentation, and Swift Argument Parser.
- 2020: 1.1.0 added all-module generation and reproducible docs.
- 2021: 2.0.0 updated for Xcode 13.
- 2022: 2.0.1 updated for Xcode 13.3 and Swift 5.6.
Related projects
- SourceDocs is conceptually related to Jazzy and Sphinx, both named in its README.
- SourceKitten is listed by SourceKitten as a project built with SourceKitten and SourceDocs uses Swift tooling to inspect source for documentation.
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 8 plateformes.
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.
exécutables
Exécutables installés
| Commande | Type | Exposition | Note |
|---|---|---|---|
sourcedocs | 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.0.1
gestionnaire mis à jour
données localesOK
amontà jour
dernière version détectée2.0.1
https://github.com/SourceDocs/SourceDocs
- infoNo package-manager update timestamp was available.confiance faible
métadonnées d'installation
Métadonnées du paquet
| Clé du paquet | brew:sourcedocs |
|---|---|
| Version | 2.0.1 |
| Gestionnaire de paquets | Homebrew |
| Page du gestionnaire de paquets | https://formulae.brew.sh/formula/sourcedocs |
| Page d'accueil | https://github.com/SourceDocs/SourceDocs |
| Dépôt | https://github.com/SourceDocs/SourceDocs |
| Docs amont | https://github.com/SourceDocs/SourceDocs#readme |
| Licence | MIT |
| Archive source | https://github.com/SourceDocs/SourceDocs/archive/refs/tags/2.0.1.tar.gz |
| Bibliothèques fournies par macOS | swift |
| Bouteille | disponible (sur arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, arm64_ventura, sonoma, ventura, x86_64_linux) |
| 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 | sourcedocs |
| Version Scheme | 0 |
| Revision | 0 |
| Requirements |
|
| Bottle Stable Root URL | https://ghcr.io/v2/homebrew/core |
| Deprecated | no |
| Disabled | no |
| Keg Only | no |
| URL Keys |
|
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 package history
- package relationship graph
- package version freshness
- package-page enrichment