安装

其他安装命令

macOS

Homebrew已验证 · 100%

brew install sourcedocs

local Homebrew formula metadata

概览

软件包摘要

Generate Markdown files from inline source code documentation

项目链接

命令和别名

sourcedocs

历史

项目历史与用法

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.

来源

安全态势

风险级别：绿色

narrow executable package without higher-risk signals.

风险分类器

绿色风险 · 低置信度 · appliance

原因

narrow executable package without higher-risk signals

信号

metadata:no-higher-risk-signals

安装行为

formula 元数据中未记录 Homebrew post-install 钩子。
Homebrew bottle 元数据适用于 8 个平台目标。

建议审查

在无人值守的代理使用前，请检查该工具是否读取明文凭据、写入远程状态、发布制品或调用插件。

可执行文件

已安装的可执行文件

命令	类型	暴露范围	备注
`sourcedocs`	cli	全局可执行文件

新鲜度

版本和新鲜度

这些信号区分页生成时间、软件包管理器活动和上游发布比较。只有存在证据 URL 和可比较版本时，才会提示版本落后。

页面生成时间2026-07-26

管理器版本2.0.1

管理器更新时间

本地数据OK

上游当前

信息No package-manager update timestamp was available.低置信度

安装元数据

软件包元数据

软件包键	brew:sourcedocs
版本	2.0.1
软件包管理器	Homebrew
软件包管理器页面	https://formulae.brew.sh/formula/sourcedocs
主页	https://github.com/SourceDocs/SourceDocs
仓库	https://github.com/SourceDocs/SourceDocs
上游文档	https://github.com/SourceDocs/SourceDocs#readme
许可证	MIT
源码归档	https://github.com/SourceDocs/SourceDocs/archive/refs/tags/2.0.1.tar.gz
macOS 提供的库	swift
Bottle	可用 (于 arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, arm64_ventura, sonoma, ventura, x86_64_linux)
Homebrew post-install	未定义
服务	未声明

注册表事实

源数据库详情

Source Database	Homebrew formula API
Tap	homebrew/core
Full Name	sourcedocs
Version Scheme	0
Revision	0
Requirements	xcode
Bottle Stable Root URL	https://ghcr.io/v2/homebrew/core
Deprecated	no
Disabled	no
Keg Only	no
URL Keys	stable

软件包图谱

链接来自本地软件包关系图、补充数据、依赖边、生态匹配和软件包 hub 归属。

来源线索

由仓库数据生成

此页面由 av-web 从 scripts/generate-pkg-sqlite.py 生成的私有软件包 SQLite 工件提供。

Combined YAML source

View the package source record on GitHub.

combined/sourcedocs.yml

使用的来源

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

使用 Homebrew 安装 sourcedocs