# swift-doc

Documentation generator for Swift projects that writes HTML or CommonMark files.


Source: https://findsoftware.frbit.cloud/swift-doc/
Last reviewed: 2026-10-23
Listed since: 2026-10-23

## Record

### Links

- repository: https://github.com/SwiftDocOrg/swift-doc

### Identity

- status: discontinued
- maintainer: Read Evaluate Press, LLC
- maintainerType: company
- parent: unknown
- firstRelease: 2020
- hqCountry: unknown

### Kind

- category: ssg
- hosting: unknown
- language: swift
- runtime: binary
- runtimeMin: unknown
- basedOn: unknown

### Content

- contentStore: unknown
- databases: unknown
- adminUi: unknown
- headlessApi: unknown
- templating: unknown
- i18n: unknown

### Rendering and deploy

- runsAs: local
- renderingModes: static
- installMethod: brew install swiftdocorg/formulae/swift-doc

### License

- licenseModel: open-source
- license: MIT

### Releases

- currentMajor: unknown
- latestReleaseDate: unknown

### Adoption

- githubStargazers: 1680
- packagistDownloads: not applicable
- npmWeeklyDownloads: not applicable
- contributors: 23
- pluginCount: unknown
- packagistMonthlyDownloads: unknown
- ecosystemsMonthlyDownloads: unknown
- httpArchiveSites: unknown
- wordpressActiveInstalls: unknown
- dependentRepos: unknown
- dependentPackages: unknown

### Sources

- status: https://api.github.com/repos/SwiftDocOrg/swift-doc (read 2026-10-23)
- urls: https://api.github.com/repos/SwiftDocOrg/swift-doc (read 2026-10-23)
- language: https://api.github.com/repos/SwiftDocOrg/swift-doc (read 2026-10-23)
- runtime: https://github.com/SwiftDocOrg/swift-doc/blob/master/README.md (read 2026-10-23)
- category: https://github.com/SwiftDocOrg/swift-doc/blob/master/README.md (read 2026-10-23)
- renderingModes: https://github.com/SwiftDocOrg/swift-doc/blob/master/README.md (read 2026-10-23)
- installMethod: https://github.com/SwiftDocOrg/swift-doc/blob/master/README.md (read 2026-10-23)
- installMethod: https://github.com/SwiftDocOrg/swift-doc/blob/master/README.md (read 2026-10-23)
- installMethod: https://github.com/SwiftDocOrg/swift-doc/blob/master/README.md (read 2026-10-23)
- license: https://api.github.com/repos/SwiftDocOrg/swift-doc (read 2026-10-23)
- licenseModel: https://github.com/SwiftDocOrg/swift-doc/blob/master/README.md (read 2026-10-23)
- firstRelease: https://api.github.com/repos/SwiftDocOrg/swift-doc/releases (read 2026-10-23)
- githubStargazers: https://api.github.com/repos/SwiftDocOrg/swift-doc (read 2026-10-23)
- contributors: https://api.github.com/repos/SwiftDocOrg/swift-doc/contributors (read 2026-10-23)
- maintainer: https://github.com/SwiftDocOrg/swift-doc/blob/master/LICENSE.md (read 2026-10-23)
- runsAs: https://github.com/SwiftDocOrg/swift-doc/blob/master/README.md (read 2026-10-23)

## Notes

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.

---

Data licensed CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/). Attributes are recorded, never scored; absent means unknown.
Credit, in full: FindSoftware, CC BY 4.0