{"id":13995564,"url":"https://github.com/NSHipster/Swift-Documentation-Example","last_synced_at":"2025-07-22T22:31:07.721Z","repository":{"id":42443976,"uuid":"151786180","full_name":"NSHipster/Swift-Documentation-Example","owner":"NSHipster","description":"A companion project to the NSHipster article about Swift Documentation","archived":true,"fork":false,"pushed_at":"2023-02-24T20:26:54.000Z","size":103,"stargazers_count":29,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-11-29T18:40:29.312Z","etag":null,"topics":["documentation","jazzy","swift"],"latest_commit_sha":null,"homepage":"https://nshipster.com/swift-documentation/","language":"Swift","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NSHipster.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2018-10-05T22:55:04.000Z","updated_at":"2023-02-24T20:27:06.000Z","dependencies_parsed_at":"2024-01-20T18:14:13.784Z","dependency_job_id":null,"html_url":"https://github.com/NSHipster/Swift-Documentation-Example","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/NSHipster/Swift-Documentation-Example","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NSHipster%2FSwift-Documentation-Example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NSHipster%2FSwift-Documentation-Example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NSHipster%2FSwift-Documentation-Example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NSHipster%2FSwift-Documentation-Example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NSHipster","download_url":"https://codeload.github.com/NSHipster/Swift-Documentation-Example/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NSHipster%2FSwift-Documentation-Example/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266585677,"owners_count":23952163,"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","status":"online","status_checked_at":"2025-07-22T02:00:09.085Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["documentation","jazzy","swift"],"created_at":"2024-08-09T14:03:29.169Z","updated_at":"2025-07-22T22:31:07.386Z","avatar_url":"https://github.com/NSHipster.png","language":"Swift","funding_links":[],"categories":["Swift"],"sub_categories":[],"readme":"# 🚲 Bicycle - Swift Documentation Example\n\nA companion project to the\n[NSHipster article about Swift Documentation](https://nshipster.com/swift-documentation/).\n\n## Requirements\n\n- Xcode\n- Git 2.16.2+\n- Ruby 2.4.3+\n- [Bundler](https://bundler.io)\n\n## Generating Docs\n\nFirst, clone the repository by opening Terminal.app\nand running the following commands:\n\n```terminal\n$ git clone git@github.com:NSHipster/Swift-Documentation-Example.git\n$ cd Swift-Documentation-Example\n```\n\nNext, download project dependencies with Bundler using the command:\n\n```terminal\n$ bundle install\n```\n\nUse [Jazzy](https://github.com/realm/jazzy)\nto generate web pages from the documentation comments of this Swift project:\n\n```terminal\n$ bundle exec jazzy -o Docs\n```\n\nNow open the `index.html` from the `Docs` directory\nto view the generated documentation:\n\n```terminal\n$ open Docs/index.html\n```\n\n## License\n\nThis project is released under the\n[MIT License](https://opensource.org/licenses/MIT).\nSee the LICENSE file for more info.\n\nNSHipster® and the NSHipster Logo\nare registered trademarks of Read Evaluate Press, LLC.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FNSHipster%2FSwift-Documentation-Example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FNSHipster%2FSwift-Documentation-Example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FNSHipster%2FSwift-Documentation-Example/lists"}