{"id":15481363,"url":"https://github.com/fwcd/swift-docc-action","last_synced_at":"2025-04-15T21:14:53.366Z","repository":{"id":42223424,"uuid":"470646447","full_name":"fwcd/swift-docc-action","owner":"fwcd","description":"GitHub Action for generating Swift documentation using DocC","archived":false,"fork":false,"pushed_at":"2024-07-03T20:19:30.000Z","size":42,"stargazers_count":17,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-12T10:18:06.076Z","etag":null,"topics":["actions","docc","documentation","swift"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fwcd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2022-03-16T15:40:04.000Z","updated_at":"2025-01-05T09:14:14.000Z","dependencies_parsed_at":"2024-10-25T05:29:34.105Z","dependency_job_id":"a33de831-1d68-4b26-a63c-7ecf126b3767","html_url":"https://github.com/fwcd/swift-docc-action","commit_stats":{"total_commits":22,"total_committers":3,"mean_commits":7.333333333333333,"dds":0.09090909090909094,"last_synced_commit":"85e84f7824057d3dc07b522d9efbe890eca1b422"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fwcd%2Fswift-docc-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fwcd%2Fswift-docc-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fwcd%2Fswift-docc-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fwcd%2Fswift-docc-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fwcd","download_url":"https://codeload.github.com/fwcd/swift-docc-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248978418,"owners_count":21192781,"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":["actions","docc","documentation","swift"],"created_at":"2024-10-02T05:04:10.936Z","updated_at":"2025-04-15T21:14:53.343Z","avatar_url":"https://github.com/fwcd.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Swift DocC Action\n\n[![Dist](https://github.com/fwcd/swift-docc-action/actions/workflows/dist.yml/badge.svg)](https://github.com/fwcd/swift-docc-action/actions/workflows/dist.yml)\n\nGenerates documentation for a Swift package using the [`swift-docc-plugin`](https://github.com/apple/swift-docc-plugin).\n\n## Usage\n\nTo use, make sure that your package includes a dependency on the plugin in your `Package.swift`:\n\n```swift\n.package(url: \"https://github.com/apple/swift-docc-plugin.git\", from: \"1.0.0\"),\n```\n\nThen include the action in your workflow (make sure that a Swift 5.6+ toolchain is on your PATH, on macOS this should be given, but on Linux you may need to first install it e.g. using [`setup-swift`](https://github.com/swift-actions/setup-swift)):\n\n```yaml\n- uses: fwcd/swift-docc-action@v1\n  with:\n    target: YourTarget\n    output: ./docs\n    hosting-base-path: yourproject\n    disable-indexing: 'true'\n    transform-for-static-hosting: 'true'\n```\n\nThe generated documentation will be in the `./docs` folder. If you wish to host your docs on GitHub Pages, check out [this tutorial from the official docs](https://apple.github.io/swift-docc-plugin/documentation/swiftdoccplugin/publishing-to-github-pages/). An example of a workflow that deploys directly to GitHub Pages [can be found here](https://github.com/ProjectLighthouseCAU/lighthouse-swift/blob/de20cd3a9fe14a71986419858caed835702190c6/.github/workflows/docs.yml).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffwcd%2Fswift-docc-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffwcd%2Fswift-docc-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffwcd%2Fswift-docc-action/lists"}