探索创新文档工具：Nef - 让文档编写更轻松

Nef，源自古埃及王后Nefertiti的名字，是一个强大的工具集，专为创建Xcode游乐场形式的文档而设计。它提供编译时的文档验证，以Markdown格式导出文档，并能生成Carbon代码片段。灵感来源于Kotlin的ΛNK和Scala的tut，Nef将帮助您提升文档质量与效率。

功能亮点

💡 第三方库支持：轻松创建包含第三方库的Xcode游乐场。

💡 游乐场编译器：命令行编译Xcode游乐场，支持从依赖管理器添加第三方库。

💡 游乐场图书构建器：基于Swift Package管理器构建适用于iPad的游乐场书籍。

💡 Markdown导出：将Nef游乐场转换为Markdown项目。

💡 Jekyll兼容：生成的Markdown文件可以无缝融入Jekyll网站。

💡 代码片段共享：直接从Nef游乐场导出Carbon代码片段。

安装

通过Homebrew（推荐）

➜ brew install nef

使用Swift Package Manager

在您的macOS项目中，作为库导入Nef：

.package(url: "https://github.com/bow-swift/nef.git", from: "{version}")

Xcode扩展安装

从App Store或发布页面安装Xcode Editor Extension。

在iPad上创作

使用iPad应用直接创建带有第三方库支持的Swift游乐场。

生成GitHub徽章

为您的GitHub仓库创建一个nef徽章。

使用

创建Nef游乐场

Nef使得创建具有第三方库支持的Xcode游乐场变得简单。默认情况下，Nef会为您创建一个支持Bow（Swift的功能编程库）的游乐场。

➜ nef playground

编译Nef游乐场

Nef提供了命令来编译游乐场，确保其正确性，非常适合集成到持续集成流程中。

➜ nef compile --project <nef playground>

构建游乐场图书

利用Swift Playgrounds 3.x的新特性，Nef可以构建包含外部依赖的游乐场图书，便于在iPad上分享代码。

➜ nef ipad --name PlaygroundName --package Package.swift --output ~/Desktop

导出Markdown项目

将Nef游乐场中的Markdown注释转化为可读性强的文档。

➜ nef markdown --project <nef playground>

Nef以其简单易用、功能强大深受开发者喜爱，无论您是想创建教程、分享代码还是制作示例，都将助您一臂之力。立即加入，享受编写高质量文档的乐趣！