Inherits from NSObject
Declared in OCDiscount.h

Overview

The OCDiscount class is used to convert markdown string to an HTML string.

Tasks

Class Methods

convertMarkdownFileAtPath:error:

Converts the markdown in a file at the given path to an HTML string.

+ (NSString *)convertMarkdownFileAtPath:(NSString *)path error:(NSError **)error

Parameters

path

The path of the file whose contents you want.

error

The error that was encountered.

Return Value

Returns an HTML string or nil if the string couldn’t be converted.

Availability

Available in 0.2.0 or later.

See Also

Declared In

OCDiscount.h

convertMarkdownFileAtURL:error:

Converts the markdown in a file at the given url to an HTML string.

+ (NSString *)convertMarkdownFileAtURL:(NSURL *)url error:(NSError **)error

Parameters

url

The url of the file whose contents you want.

error

The error that was encountered.

Return Value

Returns an HTML string, or nil if the string couldn’t be converted.

Availability

Available in 0.2.0 or later.

See Also

Declared In

OCDiscount.h

convertMarkdownString:

Converts the markdown string to an HTML string.

+ (NSString *)convertMarkdownString:(NSString *)string

Return Value

Returns an HTML string, or nil if the string couldn’t be converted.

Availability

Available in 0.2.0 or later.

Declared In

OCDiscount.h