https://github.com/docmeta/rubydoc.info

Next generation rdoc.info site
https://github.com/docmeta/rubydoc.info

rdoc ruby rubydoc yard

Last synced: 3 months ago
JSON representation

Next generation rdoc.info site

• Host: GitHub
• URL: https://github.com/docmeta/rubydoc.info
• Owner: docmeta
• License: mit
• Created: 2010-07-12T04:15:11.000Z (over 14 years ago)
• Default Branch: main
• Last Pushed: 2023-09-01T06:17:24.000Z (about 1 year ago)
• Last Synced: 2024-05-29T03:26:17.786Z (5 months ago)
• Topics: rdoc, ruby, rubydoc, yard
• Language: Ruby
• Homepage: http://rubydoc.info
• Size: 808 KB
• Stars: 132
• Watchers: 12
• Forks: 42
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • License: MIT-LICENSE

Awesome Lists containing this project

• Open-Source-Ruby-and-Rails-Apps - rubydoc.info - Next generation rdoc.info site 🔥 ✅ 🚀 (Happy Exploring 🤘)

README

        
# RubyDoc.info: YARD Doc Server

RubyDoc.info is the next generation Ruby doc server, replacing

[http://rdoc.info](http://rdoc.info) and

[http://yardoc.org/docs](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](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:

```sh

git clone git://github.com/lsegal/rubydoc.info

cd rubydoc.info

bundle install

cp config/config.yaml.sample config/config.yaml

bundle exec rake gems:update

bundle exec rake server:start

```

This will start a daemonized process, you can stop the server with:

```sh

bundle exec rake server:stop

```

### Running With Docker

If you have Docker installed, you can get started using `docker-compose`:

```sh

docker-compose up

```

Add `-d` to daemonize the process. To stop the server in daemonized mode,

run `docker-compose down`.

## 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](https://github.com/lsegal/rubydoc.info/graphs/contributors).

Pull requests welcome!

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