Nef

Overview

nef is a toolset designed to simplify the creation of documentation in the form of Xcode Playgrounds. It offers compile-time verification of documentation, exports it in Markdown format for use with Jekyll to generate websites, and can export Carbon snippets for a given Xcode Playground. nef is inspired by ΛNK for Kotlin and tut for Scala.

Features

• Eases the creation of Xcode Playgrounds with support for third party libraries
• Compiles Xcode Playgrounds with support for 3rd-party libraries from the command line
• Builds a Playground Book for iPad with external dependencies defined in a Swift Package
• Generates Markdown project from nef Playground
• Generates Markdown files that can be consumed from Jekyll to create a microsite
• Export Carbon code snippets for a given nef Playground

Using Homebrew (preferred)

Using Homebrew, you can install nef with the following steps:

1. Open your terminal.
2. Run the command: brew install nef

Using Swift Package Manager

nef can also be consumed as a library in your macOS project. To install it using Swift Package Manager: