Sherpa 是一个将用户手册显示在 iOS 应用程序中的一站式解决方案，它基于 JSON 模板。

特性

• 兼容 iOS 8.4 及以上版本。
• 提供纯 JSON 文件作为内容。
• 为上下文帮助进行深度链接到文章。
• 带查询高亮的用户搜索。
• 内置反馈机制，包括邮件和 Twitter。
• 可自定义颜色，并可选择提供一个 UITableViewCell 子类以供使用。

如何使用

Sherpa 使用 JSON 文件作为其内容来源，这使得您可以从您的应用程序包中提供一个文件，从服务器下载一个文件，或者两者兼具！它会为您处理 JSON 的解析，您只需要提供文档的本地 URL，它就会处理其余的事情。您甚至不需要将视图控制器包裹在 UINavigationController 中，因为这会自动完成；只需直接呈现 SherpaViewController 即可。

let viewController = SherpaViewController(fileAtURL: fileURL)
self.presentViewController(viewController, animated: true, completion: nil)

要深度链接到特定文章进行上下文帮助，您可以选择提供一个与您想链接的文章中匹配的 articleKey。Sherpa 将以所选文章已打开的方式进行显示，并允许用户返回到完整的文章列表以寻找额外的帮助。

let viewController = SherpaViewController(fileAtURL: fileURL)
viewController.articleKey = "related-articles"
self.presentViewController(viewController, animated: true, completion: nil)

如果您想将 Sherpa 推送到现有的 UINavigationController 栈中，这会优雅地处理，无需任何额外的配置。只需直接推送 SherpaViewController 即可。

let viewController = SherpaViewController(fileAtURL: fileURL)
viewController.articleKey = "related-articles"
self.navigationController?.pushViewController(viewController, animated: true)

有关设置 JSON 文档的更多信息，可以在 示例应用程序的 UserGuide.json 文件中找到。您可以通过运行示例应用程序本身来阅读此用户指南并查看示例的实际效果。CocoaPods 通过 `pod try Sherpa` 命令使这个过程变得容易，您可以在已安装 CocoaPods 的终端中运行此命令。

安装

CocoaPods

pod Sherpa

联系方式

如果您有任何问题，您可以在 Twitter 上找到我，或者您可以通过 电子邮件 联系我。

在 BSD 许可下发布

版权 © 2017 Daniel Farrelly

在以下条件满足的情况下，允许重新分配和使用源代码和二进制形式，无论是修改还是未修改：

• 源代码的重分发必须保留以上版权声明、本许可证列表以及以下免责声明。
• 二进制形式的重分发必须在本分发提供的文档和其他材料中复制以上版权声明、本许可证列表以及以下免责声明。

本软件由版权所有者和贡献者按“原样”提供，并不提供任何明确或暗示的保证，包括但不限于适销性和针对特定目的的适用性保证。在任何情况下，版权所有者或贡献者不对因使用本软件而导致的任何直接、间接、偶然、特殊、示范性或后果性损害（包括但不限于替代商品或服务的采购；使用、数据或利润的损失；或业务中断）承担责任，无论何种原因导致，也不论是根据合同、严格责任还是侵权（包括疏忽或其他）提起的诉讼，即使被告知此类损害的可能性。