down-gfm

Blazing fast rendering Markdown (GitHub-Flavored Markdown) in Swift, powered by:

• github/cmark-gfm
• apple/swift-cmark
• apple/swift-markdown

This is a fork of johnxnguyen/Down from version 0.11.0, swapping the embedded cmark files for the above dependencies.

WARNING: Currently missing from this fork, see #2:

• Support for ordered lists that don't start at 1.
• DownOptions that reflect cmark options

Maintainers

down-gfm maintainers

• Adrian Schönig

Down maintainers

• John Nguyen
• Rob Phillips
• Keaton Burleson
• phoney
• Tony Arnold
• Ken Harris
• Chris Zielinski
• Other contributors 🙌

Installation

This fork only maintains compatibility with Swift 5.5 and above, and the Swift Package Manager.

        .package(url: "https://github.com/maparoni/down-gfm.git", .branch("gfm")),

Differences to Down

This fork swaps cmark for cmark-gfm, and supports the GFM-extensions, with the notable exception that tables are not supported when using NSAttributedString.

For a full description of features, see johnxnguyen/Down.

Supports

Swift; iOS 13+, tvOS 13+, macOS 10.15+

Markdown Specification

down-gfm is built upon the GitHub-Flavored Markdown specification.

A little help from my friends

Please feel free to fork and create a pull request for bug fixes or improvements, being sure to maintain the general coding style, adding tests, and adding comments as necessary.

Credits

• johnxnguyen/Down
• apple/swift-markdown
• apple/swift-cmark
• github/cmark-gfm
• cmark