Swift-DocC is Now Open Source

At WWDC21, Apple announced Swift-DocC, a new documentation compiler for Swift frameworks and packages. Swift-DocC provides an effortless way to author great documentation alongside your code, and generate comprehensive documentation websites for Swift codebases. It supports API docs authored as code comments, long-form conceptual articles written in Markdown, and even step-by-step tutorials with integrated images.

→ swift.org/blog/swift-docc/

Apple introduced Swift-DocC at WWDC21 as a new documentation compiler for Swift frameworks and packages, now released as open source with support for macOS and Linux.

It integrates with tools like Xcode 13 and SwiftPM, allowing developers to write API comments, Markdown articles, and tutorials with images, all compiled into a JSON archive and rendered as websites using Swift-DocC-Render.

The tool simplifies creating and linking reference docs, conceptual articles, and tutorials within the same workflow as code, using familiar Swift comment syntax and new features like double-backtick symbol links. Future plans include deeper SwiftPM integration via plug-ins and adding Swift-DocC to Swift’s core tools, with documentation for the project already available on swift.org.