SwiftDocOrg/swift-doc

Health v2 · maintenance only

Flags: archived

Adoption not part of the score

1683 stars · 96 forks observed · 2026-08-28

What it is AI-extracted, prompt v1, taxonomy v1, 2026-08-30, confidence not recorded

A command-line documentation generator for Swift projects that reads Swift source files and produces HTML or CommonMark documentation for types, functions, and variables. It also provides subcommands for documentation coverage statistics and symbol relationship diagrams.

Use cases

• generate API documentation for a Swift package
• produce Markdown docs for a GitHub wiki from Swift source code
• generate HTML reference docs for a Swift module
• measure documentation coverage of Swift code
• generate diagrams of Swift type relationships
• document classes, structs, enums, and protocols automatically

When to choose

• you maintain a Swift library and want generated API reference docs in HTML or Markdown
• you want documentation coverage statistics for Swift code
• you prefer a lightweight CLI over Xcode-integrated tooling
• you want to publish docs to GitHub Pages or a wiki

When to avoid

• you need Swift-DocC integration or Apple-style hosted docs
• you need docs for languages other than Swift
• you need actively developed features — the project's latest release is from 2023 and it appears to be in maintenance
• you need a GUI or hosted documentation service

Facets

cli-tool · maturity maintenance

documentation cli parser documentation developer-tools cli swift doc-generator commonmark html api-reference command-line macos linux docker

Member repositories

For agents

markdown · JSON · MCP: product_card(name="SwiftDocOrg/swift-doc")