如何使用appledoc生成类似Apple的文档

Question

我正在阅读有关如何在此处生成类似Apple的HTML文档的文章.我的问题是命令行的用途.我们如何组合命令行和appledoc xcode项目来生成HTML.

Answer 1

我是appledoc工具的作者.该工具旨在用作上述Caleb的回答.推荐的安装方法是从GitHub克隆存储库,在Xcode中打开项目,构建并选择将二进制文件复制到您的路径,如上所述.此外,还必须将运行该工具所需的模板文件复制到预定义路径之一.所有必需的步骤都在GitHub上的appledoc页面上的自述文件中描述,请参阅快速安装部分.

还有其他安装方法 - 来自用户的所有贡献:

• 您可以使用install-appledoc.shgit存储库中包含的脚本.
• 还有自制的食谱,虽然它没有安装我的理解模板文件(见这个链接).

如有任何其他问题,请访问appledoc Google网上论坛.我刚刚在几天前创建了它,所以在写这篇文章时没有内容,但可以随意提问.

Answer 2

我没有使用'appledoc',但是通过快速查看你链接的页面,它似乎是一个开源命令行实用程序.因此,第一步是编译'appledoc'程序本身,然后将其粘贴在路径中的目录中,例如/usr/local/bin或~/bin/.

下一步是尝试使用它来生成一些文档(假设您已经创建了它消耗的markdown文件).打开终端窗口,导航到文件所在的目录,然后使用您链接的页面顶部给出的命令:

appledoc --project-name appledoc --project-company "Gentle Bytes" --company-id com.gentlebytes --output ~/help .

如果您希望每次构建某个项目时都使用"appledoc"重新生成文档,则可以将"运行脚本"构建阶段添加到项目中的现有目标,或者创建一个新目标,仅用于除了"运行脚本"构建阶段.无论哪种方式,该阶段的脚本应该是包含类似于上述命令的shell脚本(尽管您可能希望明确指定源目录,而不是仅使用'current'目录,即.).