Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/liyanan2004/markdownview
Rendering Markdown text natively in SwiftUI.
https://github.com/liyanan2004/markdownview
cmark commonmark markdown swift swiftui
Last synced: 3 days ago
JSON representation
Rendering Markdown text natively in SwiftUI.
- Host: GitHub
- URL: https://github.com/liyanan2004/markdownview
- Owner: LiYanan2004
- License: mit
- Created: 2022-08-10T10:18:44.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T15:47:06.000Z (2 months ago)
- Last Synced: 2024-10-30T06:58:14.735Z (about 2 months ago)
- Topics: cmark, commonmark, markdown, swift, swiftui
- Language: Swift
- Homepage: https://liyanan2004.github.io/MarkdownView/documentation/markdownview/
- Size: 6.7 MB
- Stars: 186
- Watchers: 4
- Forks: 18
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# MarkdownView
[](https://swiftpackageindex.com/LiYanan2004/MarkdownView)
[](https://swiftpackageindex.com/LiYanan2004/MarkdownView)
MarkdownView is a Swift Package for rendering Markdown natively in SwiftUI.
Thanks to [apple/swift-markdown](https://github.com/apple/swift-markdown), it can fully compliant with the [CommonMark Spec](https://spec.commonmark.org/current/).
Here is a preview :)
# Supported Platforms
You can use MarkdownView in the following platforms:
* macOS 12.0+
* iOS 15.0+
* watchOS 8.0+
* tvOS 15.0+
* visionOS 1.0+
# Highlighted Features
- Fully compliant with CommonMark
- SVG rendering support
- Highly Customizable and Extensible
- Fonts
- Code Highlighter Themes
- Tint Colors
- Block Directives
- Custom Images
- Fully Native SwiftUI implementations
# Getting started
You can create a `Markdown` view by providing a Markdown-formatted string.
```swift
MarkdownView(text: "This is the Apple's **newly published** [swift-markdown](https://github.com/apple/swift-markdown)")
```
If your Markdown have check boxes, you can provide a `Binding` string.
```swift
@State var text = """
- [x] Write the press release
- [ ] Update the website
- [ ] Contact the media
"""
```
```swift
MarkdownView(text: $text)
```
> For more information, Check out [Documentation](https://liyanan2004.github.io/MarkdownView/documentation/markdownview/)
# Further Customization
## Font
You can set custom fonts or change text styles.
```swift
MarkdownView(text: "# H1 title")
.font(.largeTitle.weight(.black), for: .h1)
```
## Tint
Default tint color for code blocks and block quotes is the accent color.
You can customize them explicitly.
```swift
MarkdownView(text: "> Quote and `inline code`")
.tint(.pink, for: .inlineCodeBlock)
```
# Add Custom Providers
You can add your custom image providers and block directive providers to display your content.
To do that, first create your provider.
```swift
struct CustomImageProvider: ImageDisplayable {
func makeImage(url: URL, alt: String?) -> some View {
AsyncImage(url: url) {
switch $0 {
case .empty: ProgressView()
case .success(let image): image.resizable()
case .failure(let error): Text(error.localizedDescription)
@unknown default: Text("Unknown situation")
}
}
}
}
```
Then apply your provider to `MarkdownView`.
```swift
MarkdownView(text: markdownText)
.imageProvider(CustomImageProvider(), forURLScheme: "my-image")
```
The implementation of the block directive is exactly the same way.
# Swift Package Manager
In your `Package.swift` Swift Package Manager manifest, add the following dependency to your `dependencies` argument:
```swift
.package(url: "https://github.com/LiYanan2004/MarkdownView.git", .branch("main")),
```
Add the dependency to any targets you've declared in your manifest:
```swift
.target(name: "MyTarget", dependencies: ["MarkdownView"]),
```
# Dependencies
- [apple/swift-markdown](https://github.com/apple/swift-markdown): Parse documents
- [raspu/Highlightr](https://github.com/raspu/Highlightr.git): Highlight code on iOS and macOS.