GHMarkdownParser技术文档

1. 安装指南

在您的项目中设置GHMarkdownParser非常简单，请按照以下步骤操作：

• 将GHMarkdownParser作为子模块添加到您的项目中。

• 切换到GHMarkdownParser目录并初始化子模块：

  git submodule init
  git submodule update
  

• 将GHMarkdownParser.xcodeproj拖放到您的项目中。

• 选择您的项目目标 -> 构建设置：

  • 在其他链接器标志中填写-Objc和-all_load。
  • 将GHMarkdownParser的路径添加到库搜索路径和头文件搜索路径。

• 进入构建阶段：

  • 将GHMarkdownParser（针对iOS）或GHMarkdownParser Mac（针对Mac）添加到目标依赖。
  • 将libGHMarkdownParser.a（针对iOS）或libGHMarkdownParser_Mac.a（针对Mac）添加到链接二进制与库。

2. 项目使用说明

GHMarkdownParser是一款用于解析GitHub风味Markdown的库，以下是使用方法：

• 首先，导入GHMarkdownParser的头文件：

  #import "GHMarkdownParser.h"
  

• 接着，可以将任何Markdown格式的字符串转换为HTML：

  NSString *markdown = ...;
  NSString *HTML = markdown.flavoredHTMLStringFromMarkdown;
  

• 如果需要更多控制，可以：

  GHMarkdownParser *parser = [[GHMarkdownParser alloc] init];
  parser.options = kGHMarkdownAutoLink; // 举例
  parser.githubFlavored = YES;
  NSString *html = [parser HTMLStringFromMarkdownString:markdownString];
  

3. 项目API使用文档

GHMarkdownParser提供的API非常简洁，主要包括：

• + (instancetype)new：创建一个GHMarkdownParser对象。
• - (NSString *)HTMLStringFromMarkdownString:(NSString *)markdownString：将Markdown字符串转换为HTML。
• @property (nonatomic) GHMarkdownOptions options：配置解析选项。
• @property (nonatomic) BOOL githubFlavored：指定是否启用GitHub风味Markdown解析。

4. 项目安装方式

项目的安装方式已在安装指南中详细说明，主要通过将其作为子模块添加到项目中，并在Xcode中进行相关配置。