TexturedMaaku

Native iOS CommonMark rendering framework in Swift using Texture and Maaku.

TexturedMaaku also supports plugins based on Maaku plugins. One plugin is provided as an example.

• Installation
• Core
• Style
• Plugins
• Highlighting
• Demo

Installation

CocoaPods

CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:

$ gem install cocoapods

To integrate TexturedMaaku into your Xcode project using CocoaPods, specify it in your Podfile:

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '10.0'
use_frameworks!

target '<Your Target Name>' do
pod 'TexturedMaaku'
end

Then, run the following command:

$ pod install

Carthage

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.

You can install Carthage with Homebrew using the following command:

$ brew update
$ brew install carthage

To integrate Maaku into your Xcode project using Carthage, specify it in your Cartfile:

github "KristopherGBaker/TexturedMaaku" ~> 0.1.0

Run carthage update to build the framework and drag the built Maaku.framework into your Xcode project.

Core

DocumentNode and DocumentViewController are the primary types for using Maaku. An example of using DocumentViewController is provided in the demo project.

Style

Style settings for fonts, colors, insets, etc can be set using the DocumentStyle type and passed to DocumentNode or DocumentViewController.

Plugins

TexturedMaaku plugins are built on top of Maaku plugins. One example plugin is provided.

Highlighting

Code block syntax highlighting can be enabled by using the TexturedMaaku/SyntaxColors subspec.

Demo

Open and run the demo project (TexturedMaakuDemo/TexturedMaakuDemo.xcworkspace) to see examples of using the framework. Or simply run

$ pod try TexturedMaaku