Code Monkey home page Code Monkey logo

texturedmaaku's Introduction

TexturedMaaku

Build Status CocoaPods Compatible Carthage compatible Platform

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

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.