nef, short for Nefertiti, mother of Ankhesenamun, is a toolset to ease the creation of documentation in the form of Xcode Playgrounds. It provides compile-time verification of documentation, exports it in Markdown format that can be consumed by Jekyll to generate websites, and export Carbon snippets for a given Xcode Playground.
nef is inspired by ฮNK for Kotlin and tut for Scala.
Features
ย
๐ป
Installation
๐
Using Homebrew (preferred)
โ brew install nef
It will warn you if there is a missing dependency and will provide guidance to install it.
ย
๐ฆ
Using Swift Package Manager
nef can be consumed as a library in your macOS project.
.package(url: "https://github.com/bow-swift/nef.git", from: "{version}")
It is an excellent option if you want to use all nef features in your macOS app, even to build new tooling on top of nef.
You can read more about how to use nef library in the nef site.
ย
๐
Using Xcode Editor Extension
Some of nef features can be used directly in Xcode as an Extension. You can install it directly from App Store or downloading the last binary from the releases section.
ย
๐ฒ
Using your iPad
You can create Swift Playgrounds -together with third-party libraries- directly in your iPad using the app nef Playgrounds.
ย
Using a GitHub badge
You can create a nef badge for your GitHub repository, and let users try your project in their iPads.
ย
Usage
๐
Creating a nef Playground
Xcode Playgrounds are a nice tool for prototyping and trying new concepts. However, third party libraries support is a bit cumbersome to add. One of the goals of nef is to make the creation of an Xcode Playground easier with support for one or more libraries.
By default, nef can create an Xcode Playground with support for Bow, the Functional Programming companion library for Swift.
โ nef playground
And you can use the following option to specify the name for the nef Playground that you are creating:
โ nef playground --output ~/Desktop --name LatestBowProject
It will create an Xcode project with support for the latest available version of Bow, named LatestBowProject in your ~/Desktop. If you open this nef playground, you will find an Xcode Playground where you can import Bow or any of its modules, and start trying some of its features.
By default, nef playground will be created for iOS platform. If you need to change it, you can use the --platform option.
โ nef playground --platform osx
If you need to take advantage of nef in your Xcode Playgrounds, you can transform your Xcode Playground into a nef Playground using the following command:
โ nef playground --playground <Xcode Playground>
Where
๐ฃ
You can create a nef Playground compatible with any different Bow version, branch or commit; even third-party dependencies
Note: The next options are mutually exclusive.
--bow-version: Specify the version of Bow that you want to use in the project. This option lets you test an old version of the library in an Xcode Playground. Example:
โ nef playground --name OldBowProject --bow-version 0.3.0
--bow-branch: Specify the branch of Bow that you want to use in the project. This option lets you test features of Bow that are still in development in a branch that has not been merged or released yet. Example:
โ nef playground --name BranchBowProject --bow-branch master
--bow-commit: Specify the commit hash of Bow that you want to use in the project. This option lets you test features of Bow exactly at the moment you need, released or not. Example:
โ nef playground --name CommitBowProject --bow-commit e70c739067be1f5700f8b692523e1bb8931c7236
--podfile: Specify a Podfile with your own dependencies. This option lets you create a Playground with support for other libraries. Create aPodfilelisting your dependencies and pass it tonef. Example:
Your Podfile, located in ./folder/dependencies:
target 'MyPodsProject' do
platform :osx, '10.14'
use_frameworks!
pod 'Bow', '~> 0.3.0'
end
โ nef playground --name MyPodsProject --podfile ./folder/dependencies/Podfile
--cartfile: Specify a Cartfile with your dependencies. Create aCartfilelisting your dependencies and pass it tonef. Example:
Your Cartfile, located in ./folder/dependencies:
github "bow-swift/Bow"
โ nef playground --name MyCarthageProject --cartfile ./folder/dependencies/Cartfile
ย
๐จ
Compiling a nef Playground
Xcode lets you check for correctness of your Xcode Playground and run it. However, Apple does not provide us commands to compile an Xcode Playground, as they do for building Xcode projects. It is particularly useful in Continuous Integration when you want to verify that your playgrounds are not broken when the libraries you depend on are updated. nef has an option to compile a nef Playground. To do this, you can run the following command:
โ nef compile --project <nef playground>
If you need to transform your Xcode Playground into a nef Playground you can check Creating a nef Playground section.
Where nef Playground where your playgrounds are located. Also, you can use the following option with this command:
--use-cache: Use cached dependencies if it is possible, in another case, it will download them. Example:
โ nef compile --project <nef playground> --use-cache
You can also clean the result of the compilation:
โ nef clean --project <nef playground>
ย
๐ฒ
Creating a Playground Book
Swift Playgrounds is a revolutionary app that makes possible to write Swift code on an iPad. In the latest updates, Swift Playgrounds 3.x has added a new feature: UserModules; it lets you include swift code and make it available across multiple chapters like modules.
nef takes advantage of these new possibilities and advancements in Swift Package Manager to build a Playground Book with external dependencies from a Swift Package specification.
Given a Package.swift like the next one:
// swift-tools-version:5.2
import PackageDescription
let package = Package(
name: "BowProject",
products: [
.library(name: "BowProject", targets: ["nef"])
],
dependencies: [
.package(url: "https://github.com/bow-swift/bow.git", from: "0.8.0"),
],
targets: [
.target(name: "nef", dependencies: ["Bow"])
]
)
you can run the following command:
โ nef ipad --name PlaygroundName --package Package.swift --output ~/Desktop
It will create a Playground Book (PlaygroundName) with support for the external dependencies and save it in ~/Desktop
Options:
--name: the name for the Playground Book to build.--package: path to the Swift Package specification.--output: path where the resulting Playground Book will be generated.
ย
๐
Generating a Markdown project
Xcode Playgrounds let you write comments in Markdown format using the symbols //: for single line comments, or /*: */ for multiline comments. Inside these comments, you can use any Markdown syntax; an example:
/*:
# This is a heading 1
This is regular text. *This is bold text*. [This is a link](http://bow-swift.io).
*/
protocol MyProtocol {}
//: ## This is a single line heading 2
It makes Xcode Playgrounds the proper tool to write an article with compilable examples. The command provided by nef to generate the Markdown files is:
โ nef markdown --project <nef playground> --output <path>
Options:
--project: Path to your nef Playground.--output: Path where the resulting Markdown project will be generated.
ย
๐
Generating Markdown files for Jekyll
As you can write comments in Markdown in Xcode Playgrounds, this makes it very suitable to write documentation with compilable examples. Leveraging this, nef can create Markdown files that can be consumed from Jekyll to generate a microsite. The command to do this is:
โ nef jekyll --project <nef playground> --output <path> --main-page <main-page>
Options:
--project: Path to your nef Playground.--output: Path where the resulting Markdown files will be generated.--main-page: Optional. Path to 'README.md' file to be used as the index page of the generated microsite.
๐ฃ
How to setup a nef Playgroud for Jekyll?
nef finds all the Xcode Playgrounds in a nef Playground. Each playground is considered a section in the generated microsite structure. For each page in a playground, an entry in the corresponding section is created. The page is transformed from Swift to Markdown using the syntax described above. As a result, a directory structure matching the nef Playground structure is generated, together with a sidebar.yml that can be used as a menu in Jekyll.
nef adds some commands to modify the Markdown transformation process. All nef commands are included as Swift comments. They begin with // nef:begin: and end with // nef:end. The supported commands are:
header: It lets you add metadata to a playground page to be consumed by Jekyll. You must provide the layout that this page will use in Jekyll. The remaining attributes are optional, and you may include any of them according to your Jekyll configuration.nefwill take care of the permalinks as well. Example (at the beginning of the playground page):
// nef:begin:header
/*
layout: docs
*/
// nef:end
hidden: It lets you hide a portion of your playground in the output Markdown file. It is useful to hide imports or supporting utility code to make an example work. Example:
// nef:begin:hidden
import Bow // This will be hidden in the Markdown file
// nef:end
struct Person {} // This will be present in the Markdown file
ย
๐
Exporting Carbon code snippets
Xcode Playgrounds are a great place for prototyping and trying new concepts. Oftentimes we want to share some Swift snippets. Carbon is a cool tool for this, and nef nicely integrates with it. You can take your nef Playground, write several pieces of code, and keep it verified. Later, you can export all your code snippets with the next command:
โ nef carbon --project <nef playground> --output <path>
Options:
--project: Path to your nef Playground.--output: Path where the resulting Carbon snippets will be generated.
๐ฃ
You can customize the output with the next commands
| Command | Description | Format | Options | Default |
|---|---|---|---|---|
--background |
Background color applied to image | hexadecimal #AABBCC, #AABBCCDD or predefined colors |
nef bow white green blue yellow orange |
nef |
--theme |
Carbon's theme to be applied | String | base16-dark blackboard cobalt duotone-dark dracula hopscotch lucario material monokai night-owl nord oceanic-next one-dark panda-syntax paraiso-dark seti shades-of-purple synthwave-84 tomorrow-night-bright twilight verminal vscode zenburn |
dracula |
--size |
Export file dimensions | Number | [1, 5] |
2 |
--font |
Font type | String | firaCode hack inconsolata iosevka monoid anonymousPro sourceCodePro darkMono droidMono fantasqueMono ibmPlexMono spaceMono ubuntuMono |
firaCode |
--show-lines |
shows/hides number of lines in code snippet | Bool | true false |
true |
--show-watermark |
shows/hides watermark in code snippet | Bool | true false |
true |
Example of use
If we have a project created by nef, and an Xcode playground with the next content:
let example = "This is an example"
print("nef is super cool: \(example)")
// nef is super cool: This is an example
Running the following command, we will customize the background color to bow,
hide the number of lines, and set the export file to size 3:
โ nef carbon --project . --output ~/Desktop/nef-carbon --background bow --size 3 --show-lines false
ย
โค๏ธ
Contributing to the project
You can contribute in different ways to make nef better:
- File an issue if you encounter a bug or malfunction in
nef. - Suggest a new use case or feature for
nef. - Open a Pull Request fixing a problem or adding new functionality. You can check the Issues to see some of the pending tasks.
- Discuss with us in the Gitter channel for Bow about all the above.
How to run the project
Open project/nef.xcodeproj in Xcode 11 (or newer) and you are ready to go. nef uses the [Swift Package Manager] to handle its dependencies - they will be resolving automatically from Xcode.
How to run the documentation project
- Go to main directory where you can find the nef Playground
Documentation.app. - Run
nef compile --project Documentation.appto set up the project with its dependencies. - Open
Documentation.app
For further information, refer to our Contribution guidelines.
ย
โ๏ธ
License
Copyright (C) 2019-2020 The nef Authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
2.3k Jan 9, 2023
14 Jan 8, 2023
7 Apr 27, 2022
3 Dec 16, 2021
64 Jun 3, 2021
6 Jul 21, 2022
188 Dec 23, 2022
833 Jan 3, 2023
94 Feb 28, 2022
2.6k Dec 9, 2022
13.9k Dec 29, 2022
10 Sep 2, 2021
161 Dec 16, 2022
349 Dec 10, 2022
105 Nov 14, 2022
6.5k Nov 30, 2022
2 May 29, 2022