{"id":13872238,"url":"https://github.com/SwiftDocOrg/SwiftMarkup","last_synced_at":"2025-07-16T02:30:32.905Z","repository":{"id":52287378,"uuid":"235645982","full_name":"SwiftDocOrg/SwiftMarkup","owner":"SwiftDocOrg","description":"Parses Swift documentation comments into structured entities","archived":true,"fork":false,"pushed_at":"2021-06-10T10:50:30.000Z","size":97,"stargazers_count":56,"open_issues_count":0,"forks_count":2,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-11-20T13:43:50.603Z","etag":null,"topics":["commonmark","documentation","swift","swift-markup"],"latest_commit_sha":null,"homepage":"","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/SwiftDocOrg.png","metadata":{"files":{"readme":"README.md","changelog":"Changelog.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-01-22T19:10:23.000Z","updated_at":"2023-10-20T00:47:06.000Z","dependencies_parsed_at":"2022-09-05T20:40:49.164Z","dependency_job_id":null,"html_url":"https://github.com/SwiftDocOrg/SwiftMarkup","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SwiftDocOrg%2FSwiftMarkup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SwiftDocOrg%2FSwiftMarkup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SwiftDocOrg%2FSwiftMarkup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SwiftDocOrg%2FSwiftMarkup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SwiftDocOrg","download_url":"https://codeload.github.com/SwiftDocOrg/SwiftMarkup/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226095608,"owners_count":17572959,"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":["commonmark","documentation","swift","swift-markup"],"created_at":"2024-08-05T23:00:37.704Z","updated_at":"2024-11-23T20:30:44.179Z","avatar_url":"https://github.com/SwiftDocOrg.png","language":"Swift","funding_links":[],"categories":["Swift"],"sub_categories":[],"readme":"# SwiftMarkup\n\n![CI][ci badge]\n[![Documentation][documentation badge]][documentation]\n\nSwiftMarkup parses [Swift Markup][swift markup] from documentation comments\ninto structured documentation entities.\n\n```swift\nimport SwiftMarkup\n\nlet markdown = #\"\"\"\nCreates a new bicycle with the provided parts and specifications.\n\n- Remark: Satisfaction guaranteed!\n\nThe word *bicycle* first appeared in English print in 1868\nto describe \"Bysicles and trysicles\" on the\n\"Champs Elysées and Bois de Boulogne\".\n\n- Parameters:\n   - style: The style of the bicycle\n   - gearing: The gearing of the bicycle\n   - handlebar: The handlebar of the bicycle\n   - frameSize: The frame size of the bicycle, in centimeters\n\n- Returns: A beautiful, brand-new bicycle,\n           custom-built just for you.\n\"\"\"#\nlet documentation = try Documentation.parse(markdown)\n\ndocumentation.summary?.description // \"Creates a new bicycle with the provided parts and specifications.\"\n\ndocumentation.discussionParts.count // 2\n\nif case .callout(let remark) = documentation.discussionParts[0] {\n    _ = remark.content // \"Satisfaction guaranteed\\\\!\"\n}\n\nif case .paragraph(let paragraph) = documentation.discussionParts[1] {\n    _ = paragraph.description // \"The word *bicycle* first appeared in English print in 1868 [ ... ]\"\n}\n\ndocumentation.parameters[0].name // \"style\"\ndocumentation.parameters[0]?.content.description // \"The style of the bicycle\"\n\ndocumentation.returns?.description // A beautiful, brand-new bicycle, custom-built just for you.\n```\n\nThis package is used by [swift-doc][swiftdoc]\nin coordination with [CommonMark][commonmark] and [SwiftSemantics][swiftsemantics]\nto generate documentation for Swift projects.\n\n## Requirements\n\n- Swift 5.2+\n\n## Installation\n\n### Swift Package Manager\n\nAdd the SwiftMarkup package to your target dependencies in `Package.swift`:\n\n```swift\nimport PackageDescription\n\nlet package = Package(\n  name: \"YourProject\",\n  dependencies: [\n    .package(\n        url: \"https://github.com/SwiftDocOrg/SwiftMarkup\",\n        from: \"0.3.0\"\n    ),\n  ]\n)\n```\n\nThen run the `swift build` command to build your project.\n\n## License\n\nMIT\n\n## Contact\n\nMattt ([@mattt](https://twitter.com/mattt))\n\n[swiftdoc]: https://github.com/SwiftDocOrg/swift-doc\n[commonmark]: https://github.com/SwiftDocOrg/CommonMark\n[swiftsemantics]: https://github.com/SwiftDocOrg/SwiftSemantics\n[swift markup]: https://developer.apple.com/library/archive/documentation/Xcode/Reference/xcode_markup_formatting_ref/MarkupSyntax.html#//apple_ref/doc/uid/TP40016497-CH105-SW1\n[ci badge]: https://github.com/SwiftDocOrg/SwiftMarkup/workflows/CI/badge.svg\n[documentation badge]: https://github.com/SwiftDocOrg/SwiftMarkup/workflows/Documentation/badge.svg\n[documentation]: https://github.com/SwiftDocOrg/SwiftMarkup/wiki\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSwiftDocOrg%2FSwiftMarkup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FSwiftDocOrg%2FSwiftMarkup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSwiftDocOrg%2FSwiftMarkup/lists"}