Skip to content

Lakr233/MarkdownView

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MarkdownView

A powerful pure UIKit framework for rendering Markdown documents with real-time parsing and rendering capabilities. Battle tested in FlowDown.

Preview

Preview

Features

  • 🚀 Real-time Rendering: Live Markdown parsing and rendering as you type
  • 🖥️ Specialized for Mobile Display: Optimized layout that extracts complex elements from lists for better readability
  • 🎨 Syntax Highlighting: Beautiful code syntax highlighting with Splash
  • 📊 Math Rendering: LaTeX math formula rendering with SwiftMath
  • 📱 iOS Optimized: Native UIKit implementation for optimal performance

Installation

Add the following to your Package.swift file:

dependencies: [
    .package(url: "https://github.com/Lakr233/MarkdownView", from: "3.4.0"),
]

Platform compatibility:

  • iOS 13.0+
  • Mac Catalyst 13.0+

Usage

import MarkdownView
import MarkdownParser

let markdownTextView = MarkdownTextView()
let parser = MarkdownParser()
let result = parser.parse("# Hello World")
let content = MarkdownTextView.PreprocessedContent(parserResult: result, theme: .default)
markdownTextView.setMarkdown(content)

Example

Check out the included example project to see MarkdownView in action:

cd Example
open Example.xcodeproj

License

This project is licensed under the MIT License. See the LICENSE file for details.

Acknowledgments

This project includes code adapted from swift-markdown-ui by Guillermo Gonzalez, used under the MIT License.


Copyright 2025 © Lakr Aream. All rights reserved.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages