{"id":13733948,"url":"https://github.com/swiftlang/swift-docc","last_synced_at":"2025-12-11T22:59:43.972Z","repository":{"id":36955286,"uuid":"387531333","full_name":"swiftlang/swift-docc","owner":"swiftlang","description":"Documentation compiler that produces rich API reference documentation and interactive tutorials for your Swift framework or package.","archived":false,"fork":false,"pushed_at":"2025-05-09T15:58:31.000Z","size":34152,"stargazers_count":1243,"open_issues_count":129,"forks_count":141,"subscribers_count":123,"default_branch":"main","last_synced_at":"2025-05-09T16:47:27.767Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://swift.org/documentation/docc","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/swiftlang.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-07-19T16:39:16.000Z","updated_at":"2025-05-09T15:58:35.000Z","dependencies_parsed_at":"2024-01-04T10:23:30.003Z","dependency_job_id":"e6bb2072-79df-47be-9b95-4f4a56ecf0b2","html_url":"https://github.com/swiftlang/swift-docc","commit_stats":{"total_commits":663,"total_committers":59,"mean_commits":11.23728813559322,"dds":0.6530920060331825,"last_synced_commit":"2336b82999bb26886c3ba598923ea459a4667468"},"previous_names":["swiftlang/swift-docc","apple/swift-docc"],"tags_count":838,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swiftlang%2Fswift-docc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swiftlang%2Fswift-docc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swiftlang%2Fswift-docc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swiftlang%2Fswift-docc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/swiftlang","download_url":"https://codeload.github.com/swiftlang/swift-docc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254159194,"owners_count":22024558,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-03T03:00:51.164Z","updated_at":"2025-12-11T22:59:43.927Z","avatar_url":"https://github.com/swiftlang.png","language":"Swift","funding_links":[],"categories":["Swift DocC","Swift"],"sub_categories":["KVC"],"readme":"# Swift-DocC\n\nSwift-DocC is a documentation compiler for Swift frameworks and packages aimed \nat making it easy to write and publish great developer documentation\n\nFor an example of Swift-DocC in action, check out \n[developer.apple.com](https://developer.apple.com/documentation).\nMuch of Apple's developer documentation,\nfrom [Reference documentation](https://developer.apple.com/documentation/GroupActivities)\nto [Tutorials](https://developer.apple.com/tutorials/swiftui),\nand [long-form content](https://docs.swift.org/swift-book/documentation/the-swift-programming-language/)\nis built using Swift-DocC.\n\nTo learn more about the essentials of this tool \nrefer to the\n[user documentation](https://www.swift.org/documentation/docc).\n\nSwift-DocC is being actively developed. For more information about the\nSwift-DocC project, see the introductory blog post\n[here](https://swift.org/blog/swift-docc/).\n\n## Contributing to Swift-DocC\n\nThe [Swift Forums](https://forums.swift.org/c/development/swift-docc) are\nthe best place to get help with Swift-DocC and discuss future plans.\n\nAs an open-source project, we value any contribution made to this tool.\nPlease see the [contributing guide](/CONTRIBUTING.md) for more information on how to \ncontribute and build DocC from source.\n\n## Getting Started with DocC\n\n`docc` is the command line interface (CLI) for Swift-DocC and provides\nsupport for generating and previewing documentation.\n\nThere are multiple ways you can make use of DocC depending on your use case:\n\n**1. For documenting packages via SwiftPM:**\n\nIf you want to generate documentation for your Swift package we recommend using the Swift-DocC Plugin. Please\nrefer to the Plugin's [documentation](https://swiftlang.github.io/swift-docc-plugin/documentation/swiftdoccplugin/) to get started with \n[building](https://swiftlang.github.io/swift-docc-plugin/documentation/swiftdoccplugin/generating-documentation-for-a-specific-target), [previewing](https://swiftlang.github.io/swift-docc-plugin/documentation/swiftdoccplugin/previewing-documentation),\nand publishing your documentation to your [website](https://swiftlang.github.io/swift-docc-plugin/documentation/swiftdoccplugin/generating-documentation-for-hosting-online) or [GitHub Pages](https://swiftlang.github.io/swift-docc-plugin/documentation/swiftdoccplugin/publishing-to-github-pages).\n\n**2. For standalone documentation:**\n\nIf you have Xcode installed, it's recommended to generate documentation using the `xcrun` command.\nYou can get DocC working by invoking `xcrun docc` in your terminal.\n\nSwift-DocC is also included in the Swift toolchain for both macOS and Linux.\n\nTo see instructions on how to use DocC from the CLI run\n```\ndocc --help\n```\n\n**3. For documenting apps, frameworks, and packages using Xcode:**\n\nIf you want to generate an API reference for your project you can use DocC via Xcode.\nPlease refer to the Xcode [documentation](https://developer.apple.com/documentation/xcode/writing-documentation)\nto learn the essentials of how to get started.\n\n## Writing and Publishing Documentation with Swift-DocC\n\nIf you want to learn how to write and format your documentation please refer to\n[Formatting Your Documentation Content](https://www.swift.org/documentation/docc/formatting-your-documentation-content).\nFor publishing go to [Distributing Documentation to Other Developers](https://www.swift.org/documentation/docc/distributing-documentation-to-other-developers).\n\nTo learn more about how Swift-DocC works internally please see [CONTRIBUTING.md](CONTRIBUTING.md).\n\n## Versioning\n\nSwift-DocC's CLI tool (`docc`) is integrated into the Swift toolchain \nand follows the Swift compiler's versioning scheme.\n\nThe `SwiftDocC` library is versioned separately from `docc`. `SwiftDocC` is under\nactive development and source stability is not guaranteed.\n\n## Bug Reports and Feature Requests\n\n### Submitting a Bug Report\n\nSwift-DocC tracks all bug reports with \n[GitHub Issues](https://github.com/swiftlang/swift-docc/issues).\nWhen you submit a bug report we ask that you follow the\n[provided template](https://github.com/swiftlang/swift-docc/issues/new?assignees=\u0026labels=bug\u0026template=BUG_REPORT.yml)\nand provide as many details as possible.\n\n\u003e **Note:** You can use the [`environment`](bin/environment) script\n\u003e in this repository to gather helpful environment information to paste\n\u003e into your bug report by running the following:\n\u003e \n\u003e ```sh\n\u003e bin/environment\n\u003e ```\n\nIf you can confirm that the bug occurs when using the latest commit of Swift-DocC\nfrom the `main` branch (see [Building Swift-DocC](/CONTRIBUTING.md#building-swift-docc)),\nit will help us track down the bug faster..\n\n### Submitting a Feature Request\n\nFor feature requests, please feel free to file a\n[GitHub issue](https://github.com/swiftlang/swift-docc/issues/new?assignees=\u0026labels=enhancement\u0026template=FEATURE_REQUEST.yml)\nor start a discussion on the [Swift Forums](https://forums.swift.org/c/development/swift-docc).\n\nDon't hesitate to submit a feature request if you see a way\nSwift-DocC can be improved to better meet your needs.\n\nAll user-facing features must be discussed\nin the [Swift Forums](https://forums.swift.org/c/development/swift-docc)\nbefore being enabled by default.\n\n\u003c!-- Copyright (c) 2021-2024 Apple Inc and the Swift Project authors. All Rights Reserved. --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswiftlang%2Fswift-docc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fswiftlang%2Fswift-docc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswiftlang%2Fswift-docc/lists"}