https://github.com/jaywcjlove/swiftui-markdown

Render Markdown text in SwiftUI.
https://github.com/jaywcjlove/swiftui-markdown

ios macos markdown markdown-preview markdown-viewer swift swift5 swiftui

Last synced: 6 days ago
JSON representation

Render Markdown text in SwiftUI.

• Host: GitHub
• URL: https://github.com/jaywcjlove/swiftui-markdown
• Owner: jaywcjlove
• License: mit
• Created: 2022-03-10T17:01:50.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-06-26T03:09:29.000Z (6 months ago)
• Last Synced: 2024-10-29T11:11:58.176Z (about 2 months ago)
• Topics: ios, macos, markdown, markdown-preview, markdown-viewer, swift, swift5, swiftui
• Language: Swift
• Homepage: https://jaywcjlove.github.io/swiftui-markdown
• Size: 1.85 MB
• Stars: 87
• Watchers: 4
• Forks: 12
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
SwiftUI Markdown

===

[![Buy me a coffee](https://img.shields.io/badge/Buy%20me%20a%20coffee-048754?logo=buymeacoffee)](https://jaywcjlove.github.io/#/sponsor)

[![CI](https://github.com/jaywcjlove/markdown/actions/workflows/ci.yml/badge.svg)](https://github.com/jaywcjlove/markdown/actions/workflows/ci.yml)

![SwiftUI Support](https://shields.io/badge/SwiftUI-macOS%20v10.15%20%7C%20iOS%20v13-green?logo=Swift&style=flat)

Render Markdown text in SwiftUI. It is a preview based on the [`Marked`](https://github.com/markedjs/marked) implementation.

https://user-images.githubusercontent.com/1680273/159059803-d844769b-36ad-44c1-a296-a657de8d099c.mov

![Markdown Package Screenshot](https://user-images.githubusercontent.com/1680273/158006647-19d180e2-2549-4cd4-b108-91778beccc1b.png)

![Markdown Package Screenshot](https://user-images.githubusercontent.com/1680273/158075575-14c9c942-5b99-479c-9935-b631bac3828e.png)

![Markdown Package Screenshot](https://user-images.githubusercontent.com/1680273/158075581-925d267f-47ce-4468-b891-0fb2467b89df.png)

## 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`:

```swift

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

```

Or [add the package in Xcode](https://developer.apple.com/documentation/xcode/adding_package_dependencies_to_your_app).

## Usage

```swift

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.

```swift

Markdown(content: $mdStr)

  .markdownStyle(

      MarkdownStyle(

        padding: 0, paddingTop: 115, paddingBottom: 2, paddingLeft: 130, paddingRight: 5

      )

  )

```

```swift

Markdown(content: $mdStr)

  .markdownStyle(MarkdownStyle(padding: 35 ))

```

## Configure



## Contributors

As always, thanks to our amazing contributors!



  



Made with [contributors](https://github.com/jaywcjlove/github-action-contributors).

## License

Licensed under the MIT License.