https://github.com/johnfairh/bebop

API docs generation for Swift and Objective-C
https://github.com/johnfairh/bebop

documentation-generator objective-c swift

Last synced: about 1 month ago
JSON representation

API docs generation for Swift and Objective-C

• Host: GitHub
• URL: https://github.com/johnfairh/bebop
• Owner: johnfairh
• License: other
• Created: 2019-12-06T13:33:08.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-05-10T17:20:31.000Z (6 months ago)
• Last Synced: 2024-05-10T18:32:35.481Z (6 months ago)
• Topics: documentation-generator, objective-c, swift
• Language: HTML
• Homepage:
• Size: 32.1 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Test](https://github.com/johnfairh/Bebop/workflows/Test/badge.svg)

Bebop: [Jazzy](https://github.com/realm/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:

```shell

brew install johnfairh/bebop/bebop/

```

Builds from source, takes a while.

Linux, approximately:

```shell

git clone [email protected]:johnfairh/Bebop.git

apt-get install libsqlite3-dev libsass0 libsass-dev

make install

```

### Examples