# markdown

**Repository Path**: mrxir/markdown

## Basic Information

- **Project Name**: markdown
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-12-08
- **Last Updated**: 2024-12-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

A Markdown NSAttributedString Parser
====================================

This is a Markdown => NSAttributedString parser built on top of a flex parser. It takes an NSString
and returns an NSAttributedString with markdown tags replaced by CoreText formatting attributes.

Adding it to your Project
-------------------------

1. Drag all of the files from the src/ directory into your project.
2. Import NSAttributedStringMarkdownParser.h in your project.
3. Create an instance of the parser object and pass it the string you wish to parse.
4. Plug the resulting NSAttributedString into your favorite NSAttributedString label implementation.

NSAttributedString Labels
-------------------------

Nimbus: https://github.com/jverkoey/nimbus
TTTAttributedLabel: https://github.com/mattt/TTTAttributedLabel

Supported Features
------------------

    *italics*
    **bold**
    ***bold italic***
    ~~strikethrough~~
    
    # Header 1
    ## Header 2
    ### Header 3
    #### Header 4
    ##### Header 5
    ###### Header 6
    
    Header 1
    ========

    Header 2
    --------
    
    http://google.com urls
    [Text] (http://google.com "alt text") urls

Example
-------

    NSAttributedStringMarkdownParser* parser = [[NSAttributedStringMarkdownParser alloc] init];
    NSAttributedString* string = [parser attributedStringFromMarkdownString:
                                  @"This is __rad__."];

See the Catalog application included with the project for more examples.