{"id":25764679,"url":"https://github.com/ipedro/swiftui-showcase","last_synced_at":"2025-07-26T10:09:51.281Z","repository":{"id":194050555,"uuid":"689779869","full_name":"ipedro/swiftui-showcase","owner":"ipedro","description":"A highly customizable template engine for in-app documentation written in SwiftUI","archived":false,"fork":false,"pushed_at":"2025-02-20T18:07:13.000Z","size":400,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-20T19:23:44.760Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://ipedro.github.io/swiftui-showcase/","language":"Swift","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/ipedro.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":"2023-09-10T21:43:22.000Z","updated_at":"2025-02-20T18:07:18.000Z","dependencies_parsed_at":"2023-09-11T11:59:09.102Z","dependency_job_id":"c0a636a9-1407-4e37-97f3-e63e1cc16d70","html_url":"https://github.com/ipedro/swiftui-showcase","commit_stats":null,"previous_names":["ipedro/swiftui-showcase"],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ipedro%2Fswiftui-showcase","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ipedro%2Fswiftui-showcase/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ipedro%2Fswiftui-showcase/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ipedro%2Fswiftui-showcase/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ipedro","download_url":"https://codeload.github.com/ipedro/swiftui-showcase/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240935082,"owners_count":19881096,"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":"2025-02-26T21:19:48.293Z","updated_at":"2025-02-26T21:19:48.866Z","avatar_url":"https://github.com/ipedro.png","language":"Swift","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Showcase\n\n![Swift](https://img.shields.io/badge/Swift-5.7-orange.svg)\n![iOS](https://img.shields.io/badge/iOS-15%2B-blue.svg)\n[![GitHub License](https://img.shields.io/github/license/ipedro/swiftui-showcase)](https://github.com/ipedro/swiftui-showcase/blob/main/LICENSE)\n[![GitHub Stars](https://img.shields.io/github/stars/ipedro/swiftui-showcase)](https://github.com/ipedro/swiftui-showcase/stargazers)\n[![GitHub Forks](https://img.shields.io/github/forks/ipedro/swiftui-showcase)](https://github.com/ipedro/swiftui-showcase/network/members)\n\nShowcase is a Swift package designed to simplify the process of documenting and showcasing SwiftUI-based components. It provides a structured approach to create, organize, and present documentation for your SwiftUI projects. Showcase offers a variety of customization options and styles for presenting code samples, previews, and more.\n\n## Features\n\n- Structured documentation for SwiftUI components.\n- Showcase your SwiftUI views' previews.\n- Showcase libraries and chapters for organized content.\n- Link external resources or documentation.\n- Display code samples with syntax highlighting.\n- Various styles for code blocks, previews, and external links.\n\n\n## Requirements\n\n- iOS 15+\n- Xcode 13+\n- Swift 5.7+\n\n## Installation\n\n### Swift Package Manager\n\nYou can easily integrate Showcase into your Xcode project using [Swift Package Manager](https://swift.org/package-manager/). Follow these steps:\n\n1. Open your project in Xcode.\n2. Go to \"File\" -\u003e \"Swift Packages\" -\u003e \"Add Package Dependency...\"\n3. Enter the following URL when prompted: https://github.com/ipedro/swiftui-showcase\n4. Choose the version or branch you want to use.\n5. Click \"Finish\" to add the package to your project.\n\nAlternatively, you can add Showcase as a dependency in your `Package.swift` file:\n\n```swift\ndependencies: [\n    .package(url: \"https://github.com/ipedro/swiftui-showcase\", from: \"0.3.0\")\n]\n```\n\nAlso: Don't forget to add `\"Showcase\"` as a dependency of your package's target.\n\n## Usage\n\n1. Import the Showcase module in your SwiftUI view file:\n\n   ```swift\n   import Showcase\n   ```\n\n2. Create and structure your showcase topics using `Topic` instances.\n\n### Showcase\n\nThe `Showcase` view is used to display your showcase topics. Here's an example:\n\n```swift\nimport SwiftUI\n\nstruct ContentView: View {\n    var body: some View {\n        NavigationView {\n            // Create a Showcase with a Topic, e.g., .card\n            Showcase(.mockCard)\n                .navigationTitle(\"Component Showcase\")\n        }\n    }\n}\n```\n\n### ShowcaseList\n\nThe `ShowcaseList` view allows you to list chapters of showcase topics. Here's an example:\n\n```swift\nimport SwiftUI\n\nstruct ContentView: View {\n    var body: some View {\n        NavigationView {\n            // Create a list with two chapters\n            ShowcaseList(\n                Chapter(\"Section 1\", .card, .accordion),\n                Chapter(\"Section 2\", .button, .text)\n            )\n            .navigationTitle(\"Component Showcase\")\n        }\n    }\n}\n```\n\n### ShowcaseNavigationView\n\nThe `ShowcaseNavigationView` view provides navigation to chapters of showcase topics. Here's an example:\n\n```swift\nimport SwiftUI\n\nstruct ContentView: View {\n    var body: some View {\n        // Create a ShowcaseNavigationView with a Chapter and optional icon\n        ShowcaseNavigationStack(\n            ShowcaseChapter(\n                \"My Chapter\", \n                Chapter(\"Section 1\", .card, .accordion),\n                Chapter(\"Section 2\", .button, .text)\n            )\n        )\n    }\n}\n```\n\n\u003c!--## Documentation--\u003e\n\n\u003c!--For detailed documentation and examples, please visit the [Showcase Wiki](https://github.com/ipedro/swiftui-showcase/wiki).--\u003e\n\n## License\n\nShowcase is released under the MIT License. See [LICENSE](LICENSE) for details.\n\n## Contributing\n\nContributions are welcome! Please see our [Contribution Guidelines](CONTRIBUTING.md) for more information.\n\n## Credits\n\nShowcase is created and maintained by [Pedro Almeida](https://x.com/ipedro).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fipedro%2Fswiftui-showcase","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fipedro%2Fswiftui-showcase","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fipedro%2Fswiftui-showcase/lists"}