将 "DocC" 归档文件(一种用于记录 Swift 框架和包的格式,参见:记录 Swift 框架或包)转换为静态 HTML 站点的工具。
关于此主题的博客文章:DocC 📚 存档与分析。
首先获取包
$ git clone https://github.com/DoccZz/docc2html.git
$ cd docc2html
然后在您的 .doccarchive
上运行它
$ swift run docc2html ~/Downloads/SlothCreator.doccarchive /tmp/SlothCreator/docs
这将在 /tmp/SlothCreatorSite 中创建静态站点。可以直接在浏览器中打开根文档,例如:
open file:/tmp/SlothCreatorSite/documentation/slothcreator/index.html
我认为现在还算合理。可以使用外部文件自定义模板(和 Site.css)。如果愿意调整 CSS 以满足您的喜好,则可以使用 docc2html 做一些实际的事情。
嗯,它越来越接近了,源代码也开始变得相当合理了。虽然你仍然可以看出它最初是一个快速的 hack。
尚未准备好用于生产环境,还需要更多工作。
这是一个非常快速的 hack/PoC,充满了怪癖,并且非常不完整。 但它有一些可以工作的部分,我们邀请大家改进它并提供 PR。 或者忽略它,并基于这些想法(并可能使用 DocCArchive)提出自己的导出器。
截至今天,该工具仅针对 SlothCreator 示例进行了测试。
它尚未导出教程,仅导出 documentation 文件夹中的文档。
目前还不多,但这是一个很好的起点。
我们还没有尝试 🥸 但希望能够将 SwiftBlocksUI 文档 迁移到它。 还需要一段时间才能实现。
GH action 需要:
Package.swift
版本修补为 5.5xcodebuild -doc
命令来生成 DocC 归档文件docc2html
docc2html 由 Always Right Institute 和 ZeeZide 提供。 我们喜欢反馈,GitHub 星星,酷炫的合同工作,大概任何你能想到的赞扬形式。