swift-doc
Documentation generator for Swift projects that writes HTML or CommonMark files.
swift-doc generates documentation for Swift projects. Given a directory of Swift files, its generate subcommand writes documentation for each class, structure, enumeration and protocol, as HTML or as CommonMark formatted for a GitHub Wiki. The coverage subcommand generates documentation coverage statistics, and the diagram subcommand writes a graph of symbol relationships in DOT format. The repository also hosts a GitHub Action that runs the generator.
Worth knowing
The repository is archived on GitHub, and the homepage named in the candidate list now redirects to an unrelated site.
Identity
Rendering and deploy
- Runs as
- Dev only2
- Rendering
- Static output2
- Install with
- brew install swiftdocorg/formulae/swift-doc2
Adoption
Sources
- 2026-10-23: Status, links, Written in, License, GitHub stars
api.github.com/repos/SwiftDocOrg/swift-doc - 2026-10-23: Runtime, Categories, Rendering, Install with, License model, Runs as
github.com/SwiftDocOrg/swift-doc/blob/master/README.md - 2026-10-23: First release
api.github.com/repos/SwiftDocOrg/swift-doc/releases - 2026-10-23: Contributors
api.github.com/repos/SwiftDocOrg/swift-doc/contributors - 2026-10-23: Maintainer
github.com/SwiftDocOrg/swift-doc/blob/master/LICENSE.md