Static generator for CocoaDocs.org and the CocoaPods.org fancy web pages
Ruby HTML CSS JavaScript
Latest commit 64e1f61 Nov 28, 2016 @orta orta committed on GitHub Merge pull request #490 from CocoaPods/shard
Make the API use sharded urls
Permalink
Failed to load latest commit information.
.github Create ISSUE_TEMPLATE.md Jun 28, 2016
appledoc_templates Use HTTPS when linking to CocoaPods Apr 5, 2015
classes Adds some nil protection against lookups inside the HTML in the READM… Aug 19, 2016
resources remove unused assets, update favicon, added local css assets May 10, 2014
spec Further escape pod names Jul 2, 2016
vendor Update headliner to correctly change the title Nov 17, 2015
views Fix show method on GitHub being blurry Jan 22, 2016
.env.sample Make the pinger submit stats data Jul 17, 2015
.gitignore Fixed a bunch more cases of improperly escaped paths, leading to whit… Oct 15, 2014
.rubocop.yml [Rakefile] Add rubocop Oct 15, 2014
.rubocop_todo.yml [Rakefile] Add rubocop Oct 15, 2014
.ruby-version [Gemfile] Remove unused cocoapods-testing dependency Jan 10, 2015
.travis.yml maybe fix travis Nov 28, 2016
Gemfile Adds support for CocoaPods trunk swift version, and defaults to 3.0 i… Oct 22, 2016
Gemfile.lock Updates Jazzy Nov 28, 2016
LICENSE split server & docs, added license & improved readme May 18, 2014
Procfile use a shell loop Mar 24, 2015
README.md README Nov 12, 2016
Rakefile Support deleting a specific pod version Jul 27, 2016
cocoadocs.rb Fix preview command to use lookups for specs Nov 28, 2016
misc.rb add a script to run each doc Jul 1, 2014
ping.rb Sigh, just use HTTParty for the sending to status Jul 17, 2015
server.rb Make the API use sharded urls Nov 28, 2016
webpages.rb Fixed a bunch more cases of improperly escaped paths, leading to whit… Oct 15, 2014

README.md

CocoaDocs.org

Build Status

CocoaDocs is essentially 2 tools, one is a script for generating complex appledoc templates and the other is a server aspect for reacting to webhook notifications.

How it works for the 99% use cases:

CocoaDocs receives webhook notifications from the CocoaPods/Specs repo on GitHub whenever a CocoaPod is updated.

A Swift Pod will create documentation using Jazzy. If this fails, perhaps due to new Swift version support, than it will fall back to Objective-C. An Objective-C Pod will use Appledoc to parse your library.

What control do I have over CocoaDocs as a library author?
  • For Objective-C projects, you have the ability to edit the styling of CocoaDocs for your own libraries to give some personal branding. This is done by adding a .cocoadocs.yml file to the root of your library, which overwrite these properties:

    highlight-font: '"GT Walsheim", "gt_walsheim_regular", "Avant Garde Gothic ITCW01Dm", "Avant Garde", "Helvetica Neue", "Arial"'
    
    body: '"Helvetica Neue", "Arial", san-serif'
    code: '"Monaco", "Menlo", "Consolas", "Courier New", monospace'
    
    highlight-color: '#ED0015'
    highlight-dark-color: '#A90010'
    
    darker-color: '#C6B7B2'
    darker-dark-color: '#A8A8A8'
    
    background-color: '#F2F2F2'
    alt-link-color: '#B7233F'
    warning-color: '#B80E3D'

    All defaults are stored in this config file for you to overwite.

  • You can find an example of styling at ARAnalytics's .cocoadocs.yml

  • You can add your own documentation guides, either from remote markdown files or from files locally inside the library. CocoaDocs will automatically convert github wiki pages to the markdown behind it.

    additional_guides:
     - https://github.com/magicalpanda/MagicalRecord/wiki/Installation
     - https://github.com/CocoaPods/CocoaPods/wiki/A-pod-specification
     - docs/Getting_started.md
  • If you host your own documentation, and/or just prefer to not use CocoaDocs you can use the documentation_url reference in your Podspec.

Previewing my library in CocoaDocs

First, clone this repo: git clone https://github.com/CocoaPods/cocoadocs.org then run bundle install and then run bundle exec rake install_tools to get all pre-requisite apps set up.

To preview your library run:

bundle exec ./cocoadocs.rb preview ARAnalytics

This will get the master version of your library and run it through CocoaDocs, then open the resulting folder, you can open the index.html in a web browser to preview locally.

CocoaDocs Admin

The CocoaPods' CocoaDocs server is hosted on macminicolo.net provided by Button. We use RSA public keys to log in. You'll have to get your id_rsa.pub to an existing admin ( currently orta /segiddins ) to get access.

SSH access is automated via the Rakefile:

  • bundle exec rake deploy - will log in via SSH, stop the API server, update it and then bring the server back up.

  • bundle exec rake doc["pod_name"] - will log in via SSH, and run a re-doc for a pod. Similar to the redeploy API, but you can see the logs.

Thanks!

The creation of CocoaDocs v2 has been made possible with help from the following: