Swift DocC Documentation Tool
Article Summary
Franklin Schrans from Apple's Swift-DocC team just announced something iOS developers have been waiting for: Swift-DocC is now open source and cross-platform. Documentation just got a serious upgrade.
Apple's new documentation compiler, announced at WWDC21 and shipped with Xcode 13, is now available as open source with support for macOS and Linux. Swift-DocC lets developers write API docs, long-form articles, and interactive tutorials all alongside their code, then generates beautiful documentation websites automatically.
Key Takeaways
- Four open source components: compiler, web renderer, Markdown parser, and SymbolKit library
- Double-backtick syntax creates validated links between symbols automatically
- Supports API docs, Markdown articles, and step-by-step tutorials in one workflow
- Coming to Swift Package Manager via extensible plugins through Swift Evolution
- Works with existing Swift doc comment syntax from Jazzy and SwiftDoc
Critical Insight
Swift-DocC brings Apple-quality documentation tooling to the entire Swift ecosystem, making it as easy to build docs as it is to build code.
