Bypass is a markdown library that can directly render markdown as stylized text
UIView. It features nicely styled text, tappable links, and a smooth
crossfade between representations for different device orientations.
Bypass requires iOS version 6.0 or greater.
Choose from either CocoaPods inclusion or git submodule inclusion for integrating Bypass into your project.
You can find a sample project that integrates Bypass using CocoaPods here.
Assuming you have CocoaPods installed, you can start using Bypass by doing the following:
- Create your Xcode project
- Add a
Bypassalongside your Xcode project with the following content:
platform :ios, '6.0' pod 'Bypass', '~> 1.0.1'
pod installon the command line from the root project directory
- Start development by using the generated workspace in Xcode
You can find a sample project that integrates Bypass using Git submodules here.
- Create your Xcode project and initialize your git repository.
- Assuming you have a directory named
Libraries, issue the command
git submodule add firstname.lastname@example.org:Uncodin/bypass-ios.git Libraries/Bypass
- Issue the command
git submodule update --init --recursive
- Open your Xcode project and drag the
Libraries/Bypass/Bypass.xcodeprojinto your project by dropping it into the Project Navigator
- Navigate to your project's Build Settings
Other Linker Flags
- Navigate to your project's Build Phases
Bypassas a target dependency
- In the same tab, add
libBypass.ato the list of libraries to link against.
Bypass is very easy to use. An example usage follows:
CGRect markdownRect = CGRectMake(0.f, 0.f, 100.f, 100.f); BPMarkdownView *markdownView = [[BPMarkdownView alloc] initWithFrame:markdownRect]; NSString *markdown = @"# Hello, world!" "" "This is my text body. There are many like it, " "but this one is mine."; [markdownView setMarkdown:markdown]; [[self view] addSubview:markdownView];
Feel free to directly embed a
BPMarkdownView in a Nib or Storyboard, but
ensure that you have configured your Other Linker Flags to contain
if you do this.