Skip to content

jaywcjlove/swiftui-markdown

Repository files navigation

SwiftUI Markdown

Buy me a coffee CI SwiftUI Support

Render Markdown text in SwiftUI. It is a preview based on the Marked implementation.

swiftui-markdown.mov

Markdown Package Screenshot

Markdown Package Screenshot

Markdown Package Screenshot

Installation

You can add MarkdownUI to an Xcode project by adding it as a package dependency.

  1. From the File menu, select Add Packages…
  2. Enter https://github.com/jaywcjlove/swiftui-markdown the Search or Enter Package URL search field
  3. Link Markdown to your application target

Or add the following to Package.swift:

.package(url: "https://github.com/jaywcjlove/swiftui-markdown", from: "1.0.0")

Or add the package in Xcode.

Usage

import SwiftUI
import Markdown

struct ContentView: View {
  @State private var mdStr: String = """
    ## Hello World
    
    Render Markdown text in SwiftUI.
    """
  var body: some View {
    VStack {
      Markdown(content: $mdStr)
      TextEditor(text: $mdStr)
    }
  }
}

.markdownStyle()

Setting markdown related styles.

Markdown(content: $mdStr)
  .markdownStyle(
      MarkdownStyle(
        padding: 0, paddingTop: 115, paddingBottom: 2, paddingLeft: 130, paddingRight: 5
      )
  )
Markdown(content: $mdStr)
  .markdownStyle(MarkdownStyle(padding: 35 ))

Configure

image

Contributors

As always, thanks to our amazing contributors!

Made with contributors.

License

Licensed under the MIT License.