Package - johnfairh/Bebop

Swiftpack.co is a collection of thousands of indexed Swift packages. Search packages.

johnfairh/Bebop

API docs generation for Swift and Objective-C

.package(url: "https://github.com/johnfairh/Bebop.git", from: "v1.4.0")

Bebop: Jazzy API docs generation with extra bits. There are bells and whistles.

Swift/Objc/Both everywhere
Localize everything, doc comments to images
Input SPM/Xcodeproj/Podspec/binary .swiftmodule, output html/dash docset/markdown, various flavors of json
Multi-module/multi-pass
Commonmark + extensions + custom extensions, KaTeX
Apple/Jazzy/Hybrid/Custom layout
Flexible web theme, keybinds, more navigation
Integrate with other docsets, online/inline Apple docs, github/gitlab/bitbucket/custom
Mostly compatible with Jazzy CLI / config file / themes -- migration aide+
Experiment with monolithic project and heavy dependencies

macOS:

brew install johnfairh/bebop/bebop/

Builds from source, takes a while.

Linux, approximately:

git clone git@github.com:johnfairh/Bebop.git
apt-get install libsqlite3-dev libsass0 libsass-dev
make install

child-item-style=separate, close to apple.com style trad jazzy nested style objc/swift mode

dash docset dark mode guide presentation

Stars: 0

Last commit: 1 week ago

1.3.0

5 weeks ago

Enhancements

Model documentation of throws as a full section instead of a callout -- much clearer to do this having worked with a project that makes extensive use of throwing errors.
Improve inherited docs logic, see --inherited-docs-style and --inherited-docs-extension-style.
Update npm dependencies.

Don't autolink names written in lowercase to case-insensitive versions on apple.com. Prevents unexpected (wrong) links for writing eg. void.

See all