DocCArchive

用于读取和处理 "DocC" 归档文件的 Swift 包，DocC 归档文件是一种用于记录 Swift 框架和包的格式：Swift 框架或包文档。

关于此主题的博客文章：DocC 📚 已归档和分析。

状态

该模块可以导入在 SlothCreator 示例中创建的所有文档。

它应该相当完整了。

如果您发现问题（通常通过断言或 fatalError 标记），请 告知我们，我们将尽快修复缺失的情况（也欢迎提交 PR）。

待办事项

添加 DocC 文档！🤦‍♀️
添加测试套件（由于大小原因，未添加现有的测试套件）。

在 Swift 包中使用

Package.swift 示例

// swift-tools-version:5.0

import PackageDescription

let package = Package(
  name         : "hackdocc",
  products     : [ .executable(name: "hackdocc", targets: [ "hackdocc" ]) ],
  dependencies : [
    .package(url: "https://github.com/DoccZz/DocCArchive.git", from: "0.1.1")
  ],
  targets: [ .target(name: "hackdocc", dependencies: [ "DocCArchive" ]) ]
)

使用代码

DocCArchive 有三个主要类型

DocCArchive，表示整个归档结构
DocumentFolder ，表示该结构中的一个文档文件夹
Document，表示一个文档页面（主题、类型、教程等，“JSON 文件”）

打开归档文件，访问文档文件夹（另一个是教程文件夹），然后可以在文件夹中打开 Document。

let url     = URL(fileURLWithPath: "~/Downloads/SlothCreator.doccarchive")
let archive = try DocCArchive(contentsOf: url)

if let docs = archive.documentationFolder() {
  ... work it ...
}

贡献者

servedocc 由 Always Right Institute 和 ZeeZide 呈现。我们喜欢反馈、GitHub 星星、酷炫的合同工作，以及您能想到的任何形式的赞扬。