macOS
Homebrewverified · 100%
brew install sourcedocsprovider-native install command
brew / rank 6804
Install sourcedocs with Homebrew
Generate Markdown files from inline source code documentation. Version 2.0.1 via Homebrew; verified from local package data.
install
Additional install commands
overview
Package summary
Generate Markdown files from inline source code documentation
Project links
Commands and aliases
- sourcedocs
history
Project history and usage
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.
Project history
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.
Adoption history
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.
How it is used
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.
Why package nerds care
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.
Timeline
- 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
security posture
Risk level: green
narrow executable package without higher-risk signals.
Risk classifier
green risk · low confidence · appliance
Why
- narrow executable package without higher-risk signals
Signals
- metadata:no-higher-risk-signals
Install behavior
- No Homebrew bottle metadata was recorded.
Recommended review
Before unattended agent use, check whether the tool reads plaintext credentials, writes remote state, publishes artifacts, or shells out to plugins.
executables
Installed executables
| Command | Kind | Exposure | Note |
|---|---|---|---|
sourcedocs | executable | indexed executable | Discovered from the local executable index. |
freshness
Version and freshness
These signals separate page generation age, package-manager activity, and upstream release comparison. Version lag is warned only when an evidence URL and comparable versions are present.
page generated2026-08-03
manager version2.0.1
manager updated
local dataunknown
upstreamnot available
latest detectednot detected
- okNo freshness warnings were generated.
install metadata
Package metadata
| Package key | brew:sourcedocs |
|---|---|
| Version | 2.0.1 |
| Package manager | Homebrew |
| Homepage | https://github.com/SourceDocs/SourceDocs |
| Repository | https://github.com/SourceDocs/SourceDocs |
| Bottle | not recorded |
| Service | none declared |
source trail
Generated from repository data
This page is generated by av-web from the private package SQLite artifact built by scripts/generate-pkg-sqlite.py.
Combined YAML source
View the package source record on GitHub.
Used sources
- Geiger risk classifier
- Nucleus package database
- curated package history
- pkgdb category and tag curation