一个基于 JSON 模板，用于在 iOS 应用中显示用户指南的即插即用解决方案。

特性

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

安装

Swift Package Manager（仅适用于 Apple 平台）

在 Xcode 中，选择File > Swift Packages > Add Package Dependency 并输入仓库 URL

https://github.com/jellybeansoup/ios-sherpa

CocoaPods

将以下行添加到您的 Podfile

pod 'Sherpa'

Carthage

将以下行添加到您的 Cartfile

github "jellybeansoup/ios-sherpa"

如何使用

Sherpa 使用 JSON 文件作为其内容源，这允许您在应用程序包中提供文件，从服务器下载文件，或者两者都进行！它会为您处理 JSON 的解析，您只需要提供文档的本地 URL，它就会处理其余的事情。您甚至不需要将视图控制器包装在 UINavigationController 中，因为这是自动完成的；只需直接 present 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 堆栈中，则可以优雅地处理，而无需任何额外的配置。只需直接 push SherpaViewController 即可。

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

有关设置 JSON 文档的更多信息，请参见示例应用程序的 UserGuide.json 文件。您可以阅读本用户指南，并通过运行示例应用程序本身来查看实际示例。如果您安装了 CocoaPods，可以通过在终端运行 pod try Sherpa 命令轻松完成此操作。

文档

您可以在此处找到该项目的文档。该文档使用 jazzy 从 GitHub Action 自动生成，并由 GitHub Pages 托管。

要在本地生成文档，请从 repo 的根目录运行 make documentation 或 sh ./scripts/documentation.sh。输出将在 docs 文件夹中生成，并且不应包含在提交中（因为在线文档会自动生成和更新）。

联系方式

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

根据 BSD 许可证发布

允许在源和二进制形式中重新分发和使用，无论是否进行修改，只要满足以下条件

源代码的重新分发必须保留上述版权声明，此条件列表和以下免责声明。
二进制形式的重新分发必须在随发行版提供的文档和/或其他材料中复制上述版权声明、本条件列表和以下免责声明。