martijnwalraven / cocoadocs.org Goto Github PK

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.

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

This triggers a process that will generate documentation for objective-c projects via appledoc and host them for the community. This process can take around 15 minutes after your Podspec is published via trunk.

At the minute 404 errors are likely to occur at our end due to work on trying to move to a queuing system. Presuming your library is made out of objc.

• 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.

First, clone this repo: git clone https://github.com/CocoaPods/cocoadocs.org then run bundle install you will need a working copy of appledoc ( which you can get a binary version from their github releases page as compiling doesn't work in Xcode 5.1+. ) and cloc (use brew install cloc)

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.

You'll need to have a working copy of s3cmd installed, likely with brew install.

• Starting the webhook server is as simple as running ./server.rb
• Creating a doc and uploading to S3 for the most recent version of a pod: ./cocoadocs cocoadocs doc [pod_name or path_to_podspec]
• Reparsing & uploading x amount of days worth of CocoaPods: ./cocoadocs cocoadocs days [days]

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

• Orta Therox - Design & Code
• Kyle Fuller - Admin & Code
• Delisa Mason - Docstat gem
• Clay Allsopp - Readme Complexity gem
• Ash Furrow - Javascript & Ruby assistance
• Boris Bugling - Boring legwork on templates