Skip to content

Marypaz/rubydoc.info

 
 

Repository files navigation

RubyDoc.info: YARD Doc Server

RubyDoc.info is the next generation Ruby doc server, replacing http://rdoc.info and http://yardoc.org/docs. This doc server uses YARD to generate project documentation on the fly, for both published RubyGems as well as GitHub projects.

The public doc server is hosted at http://www.rubydoc.info

Getting Started

This site is a public service and is community-supported. Patches and enhancements are welcome.

Running the doc server locally is easy:

$ git clone git://github.com/lsegal/rubydoc.info
$ cd rubydoc.info
$ bundle install
$ rake gems:update
$ rackup config.ru

Thanks

RubyDoc.info was created by Loren Segal (YARD) and Nick Plante (rdoc.info) and is a project of DOCMETA, LLC. Additional help was provided by our friendly developer community. Pull requests welcome!

(c) 2018 DOCMETA LLC. This code is distributed under the MIT license.

About

Next generation rdoc.info site

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Ruby 60.8%
  • HTML 29.4%
  • CSS 6.4%
  • JavaScript 3.0%
  • Dockerfile 0.4%