# 使用 Homebrew 安装 sourcedocs

查看 sourcedocs 的安装路径、可执行文件、元数据以及面向 AI 代理工作流的安全说明。

## 安装

```sh
sudo av install brew:sourcedocs
```

其他安装命令:

### macOS

- Homebrew (100%):

```sh
brew install sourcedocs
```

  证据: local Homebrew formula metadata

## 软件包事实

- **软件包键:** brew:sourcedocs
- **软件包管理器:** Homebrew
- **版本:** 2.0.1
- **来源摘要:** Generate Markdown files from inline source code documentation
- **主页:** <https://github.com/SourceDocs/SourceDocs>
- **仓库:** <https://github.com/SourceDocs/SourceDocs>
- **已生成:** 2026-08-03T19:37:03+00:00

## 可执行文件

- sourcedocs (别名)

## 安装行为

- Bottle: 不可用

## 版本和新鲜度

- 页面生成时间: 2026-08-03
- 管理器版本: 2.0.1
## 项目历史与用法

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.

### 项目历史

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.

### 采用历史

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.

### 使用方式

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.

### 为什么软件包爱好者会关心

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.

### 时间线

- 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.

### 来源

- <https://github.com/SourceDocs/SourceDocs#readme>
- <https://github.com/SourceDocs/SourceDocs/blob/master/CHANGELOG.md>
- <https://github.com/SourceDocs/SourceDocs/releases>


## 安全说明

narrow executable package without higher-risk signals.

- **Geiger 风险:** 绿色 / 低
- narrow executable package without higher-risk signals


## Combined YAML source

View the package source record on GitHub. [combined/sourcedocs.yml](https://github.com/mxcl/pkgdb/blob/main/combined/sourcedocs.yml)


## 来源

- pkg.so package database
- Geiger risk classifier
- curated package history
- pkgdb category and tag curation
- cross-ecosystem install command graph