docc2json is a fast Go CLI tool that converts Apple's DocC documentation output into a clean, structured JSON schema optimized for web documentation sites and SDKs. It parses DocC JSON files and transforms them into API-deployable documentation.
docc2json is a specialized command-line tool designed for developers and technical writers who need to transform Apple's proprietary DocC documentation format into a universally accessible, structured JSON schema. It serves iOS and Swift SDK developers, documentation engineers, and teams building custom documentation websites by parsing the JSON files generated by DocC from .doccarchive bundles or processed documentation folders. The primary purpose is to bridge the gap between Xcode's native documentation system and web-based documentation platforms, enabling the deployment of SDK documentation as a consumable API. This tool meticulously extracts all embedded documentation—including abstracts, discussions, and code examples—and restructures it into a clean, web-optimized JSON format that can be seamlessly integrated into custom frontends, static site generators, or developer portals.
Apple's DocC (Documentation Compiler) is a powerful tool for generating documentation directly from Swift source code, but its output is primarily designed for integration within Xcode and Apple's developer ecosystem. This creates a significant pain point for teams that need to publish SDK documentation on public websites, internal developer portals, or cross-platform documentation systems. The native DocC output is not readily consumable by standard web technologies or documentation frameworks, forcing developers to manually extract or rebuild documentation, which is time-consuming, error-prone, and difficult to maintain. docc2json directly addresses this by automating the conversion process, eliminating the manual effort required to adapt DocC's complex JSON structures for web use, and ensuring documentation remains synchronized with the source code.
One of the tool's major feature groups is comprehensive documentation extraction and structured output generation. It fully parses DocC JSON to extract detailed documentation components, including the abstract (a brief one-line description), the discussion (detailed explanations from ## Discussion sections), and code examples from ## Example sections with full code listings. For methods, it extracts parameter descriptions, return value documentation, and exception documentation for throwing methods. The output is a richly structured JSON schema that includes type representations (classes, structs, actors), protocol representations, and enum representations, each containing their respective properties, methods, initializers, and conformances. This deep extraction ensures that the nuanced documentation written by developers is preserved and transformed into a format that can be rendered beautifully on the web.
Publisher
A
admin
Launch Date2026-01-03
Platformdesktop
Pricingfree
Tech Stack
#Go#Swift#DocC#JSON