APIs

nef provides all its features as a library that you can consume in your macOS project. It enables you to build new tooling on top of nef.

It gives you easy access to render Markdown files, Jekyll content and Carbon images in a functional way. Also you can compile or clean your nef Playgrounds, even make an Xcode Playground or Playground Book compatible with 3rd-party libraries.

Playground

Xcode Playgrounds are a friendly tool for prototyping and trying new concepts. However, they have some limitations, if you need to create playgrounds with 3rd-party libraries support or make your Xcode Playground compatible with the rest of the options.

You can find more information in Playground API docs.

Compile

You can compile a nef Playground in the same way you do from Xcode Playground IDE.

You can find more information in Compile API docs

Clean

You can clean a nef Playground, for example to share it as light as possible (without any extra compilation file).

You can find more information in Clean API docs

Markdown

This API lets you render the content of a Playground page, or anything else that contains markup formatting and code.

You can find more information in Markdown API docs.

Jekyll

This API lets you render content that contains markdown, code, and nef commands to create a verified static website or blog.

You can find more information in Jekyll API docs.

Carbon

You can share some Swift snippets as images using this API that integrates with Carbon. nef lets you render Carbon images given a configuration (including code to render and style)

You can find more information in Carbon API docs.

Playground Book

Swift Playgrounds is a useful app that makes possible to write Swift code on an iPad. This API lets you create a Playground Book with external dependencies from a Swift Package specification.

You can find more information in Playground Book API docs.