4 ms·

Hey guys & gals, I created cocoadocs to try and fill a gap in the iOS ecosystem. It's a site that acts similar to rubydocs in that it gets the latest cocoapods

by orta 14y ago

Hey guys & gals, I created cocoadocs to try and fill a gap in the iOS ecosystem. It's a site that acts similar to rubydocs in that it gets the latest cocoapods libraries and documents them using a custom flavour of appledoc. I'm planning on adding support for Xcode and Dash over the next few weeks to make it even easier to use!

orta 14y ago
I've been experimenting with adding Github search links for methods and properties too - so you can get context on their uses ( this has them when you mouse over further down the page: http://cocoadocs.org/docsets/AFIncrementalStore/0.4.0/Classes/AFIncrementalStore.html http://cocoadocs.org/docsets/AFIncrementalStore/0.4.0/Classe... )
mmorey 14y ago
If you provide a /search?query=%s endpoint I would build an Alfred V2 Workflow for it. Downloading the whole documents.jsonp file each time is slow.
- orta 14y ago
  I'd love to but ATM its a static site hosted on s3, so no API at all. Moving to something which is API / Client is within my next major move, at that point it will be super easy.
  - nmcfarl 14y ago
    Just having a HTML doc with a meta refresh from the distribution to the latest version would make a lot of things easier. IE have http://cocoadocs.org/docsets/NUI/ http://cocoadocs.org/docsets/NUI/ Redirects to: http://cocoadocs.org/docsets/NUI/0.2.7/ http://cocoadocs.org/docsets/NUI/0.2.7/ This would enable http://cocoadocs.org/docsets/%s http://cocoadocs.org/docsets/%s shortcuts
    - MaxGabriel 14y ago
      Orta already made an issue for this in the CocoaDocs repo :)
bennyg 14y ago
Looks great! Only one thing, how often is it updated? I pushed a new Podspec to the master repo about 5 days ago for one of my projects (http://cocoadocs.org/docsets/Colours/0.0.1/ http://cocoadocs.org/docsets/Colours/0.0.1/) and it should be v1.0.1. Just wondering if you are doing live grabbing of the data or have it cached somewhere?
- orta 14y ago
  Cached for the moment, I'm wrapping up the CI server which will be constantly updating podspecs from this week onwards.
SeoxyS 14y ago
This is fantastic. Great work… I will be adding this to my repertoire of resources.
brotchie 14y ago
Nice! I have a "pod" in the Cocoa Pods repository and the documentation has been reproduced faithfully! I like how you pull the github README to use at the documentation landing page.

by orta 14y ago

orta 14y ago

I've been experimenting with adding Github search links for methods and properties too - so you can get context on their uses ( this has them when you mouse over further down the page: http://cocoadocs.org/docsets/AFIncrementalStore/0.4.0/Classes/AFIncrementalStore.html http://cocoadocs.org/docsets/AFIncrementalStore/0.4.0/Classe... )

mmorey 14y ago

If you provide a /search?query=%s endpoint I would build an Alfred V2 Workflow for it. Downloading the whole documents.jsonp file each time is slow.

orta 14y ago
I'd love to but ATM its a static site hosted on s3, so no API at all. Moving to something which is API / Client is within my next major move, at that point it will be super easy.
- nmcfarl 14y ago
  Just having a HTML doc with a meta refresh from the distribution to the latest version would make a lot of things easier. IE have http://cocoadocs.org/docsets/NUI/ http://cocoadocs.org/docsets/NUI/ Redirects to: http://cocoadocs.org/docsets/NUI/0.2.7/ http://cocoadocs.org/docsets/NUI/0.2.7/ This would enable http://cocoadocs.org/docsets/%s http://cocoadocs.org/docsets/%s shortcuts
  - MaxGabriel 14y ago
    Orta already made an issue for this in the CocoaDocs repo :)

bennyg 14y ago

Looks great! Only one thing, how often is it updated? I pushed a new Podspec to the master repo about 5 days ago for one of my projects (http://cocoadocs.org/docsets/Colours/0.0.1/ http://cocoadocs.org/docsets/Colours/0.0.1/) and it should be v1.0.1. Just wondering if you are doing live grabbing of the data or have it cached somewhere?

orta 14y ago
Cached for the moment, I'm wrapping up the CI server which will be constantly updating podspecs from this week onwards.

SeoxyS 14y ago

This is fantastic. Great work… I will be adding this to my repertoire of resources.

brotchie 14y ago

Nice! I have a "pod" in the Cocoa Pods repository and the documentation has been reproduced faithfully! I like how you pull the github README to use at the documentation landing page.