johnfairh / Bebop

API docs generation for Swift and Objective-C

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Test

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, Docc sites, 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

Install

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

Examples

About

API docs generation for Swift and Objective-C

License:Other


Languages

Language:HTML 53.3%Language:Swift 27.9%Language:CSS 13.3%Language:JavaScript 2.2%Language:Mustache 1.9%Language:SCSS 1.1%Language:Makefile 0.1%Language:Ruby 0.1%Language:Objective-C 0.1%Language:C 0.0%