Contents

swiftdocorg/swiftmarkup

SwiftMarkup parses [Swift Markup][swift markup] from documentation comments

Requirements

  • Swift 5.2+

Installation

Swift Package Manager

Add the SwiftMarkup package to your target dependencies in Package.swift:

import PackageDescription

let package = Package(
  name: "YourProject",
  dependencies: [
    .package(
        url: "https://github.com/SwiftDocOrg/SwiftMarkup",
        from: "0.3.0"
    ),
  ]
)

Then run the swift build command to build your project.

License

MIT

Contact

Mattt (@mattt)

[swiftdoc]: https://github.com/SwiftDocOrg/swift-doc [commonmark]: https://github.com/SwiftDocOrg/CommonMark [swiftsemantics]: https://github.com/SwiftDocOrg/SwiftSemantics [swift markup]: https://developer.apple.com/library/archive/documentation/Xcode/Reference/xcode_markup_formatting_ref/MarkupSyntax.html#//apple_ref/doc/uid/TP40016497-CH105-SW1 [ci badge]: https://github.com/SwiftDocOrg/SwiftMarkup/workflows/CI/badge.svg [documentation badge]: https://github.com/SwiftDocOrg/SwiftMarkup/workflows/Documentation/badge.svg [documentation]: https://github.com/SwiftDocOrg/SwiftMarkup/wiki

Package Metadata

Repository: swiftdocorg/swiftmarkup

Default branch: main

README: README.md