# SwiftDocOrg/swift-doc

A documentation generator for Swift projects

Repository: https://github.com/SwiftDocOrg/swift-doc
Canonical: https://ross.abutalabs.com/products/swift-doc
Homepage: https://swiftdoc.org
Language: Swift
License: MIT
License Family: permissive
Topics: swift, documentation-generator
Archived: true
Last push: 2023-06-01T03:58:47+00:00

## Health v2 (maintenance only)
Score: 10/100 (v2, computed 2026-09-02T17:46:02.011165+00:00)
- activity 0, release rhythm 8, longevity 100
- inputs: {"age_days": 2410, "days_push": 1189, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: archived
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 1683, forks 96 (observed 2026-08-28T04:05:21.839759+00:00)

## What it is
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
- artifact type: cli-tool
- maturity: maintenance
- function: documentation, cli, parser
- domain: documentation, developer-tools
- platform: cli
- tags: swift, doc-generator, commonmark, html, api-reference, command-line, macos, linux, docker

## Member repositories
- SwiftDocOrg/swift-doc (main) score 10

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:05:21.839759+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T03:41:18.458273+00:00, confidence not recorded.
  - readme: https://github.com/SwiftDocOrg/swift-doc (fetched 2026-08-28T04:05:21.839759+00:00, sha eac18930a841)
  - homepage: https://swiftdoc.org (fetched 2026-08-29T11:14:13.944627+00:00, sha a1d818d6b336)
- Data as of 2026-08-30T08:39:29.467469+00:00.