Giter Club home page Giter Club logo

rubydoc.info's Introduction

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://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
  • rake server:setup
  • git clone git://github.com/lsegal/yard yard (optional)
  • rackup config.ru

Contributors

RubyDoc.info was created by Loren Segal (YARD) and Nick Plante (rdoc.info). Additional help was provided by:

  • Jeff Rafter (rdoc.info)
  • Brian Turnbull (rdoc.info)
  • Lee Jarvis

rubydoc.info's People

Contributors

koraktor avatar lsegal avatar ngollan avatar zapnap avatar

Stargazers

avatar

Watchers

avatar avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.