Skip to content
Search and find Ruby documentation
Ruby HTML JavaScript CSS
Branch: master
Clone or download
colby-swandale Bump puma from 4.2.1 to 4.3.0 (#215)
Bump puma from 4.2.1 to 4.3.0
Latest commit ff86d44 Nov 9, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/workflows change ruby version back to 2.6.3 Oct 24, 2019
app fix stylings for header buttons/popovers Nov 3, 2019
bin upgrade webpacker Mar 19, 2019
config add sitemap redirect Nov 4, 2019
db remove activerecord until we need it in the future Sep 6, 2019
lib add rake task to generate sitemap Oct 26, 2019
log init commit 🎉 Jan 25, 2019
public use meta_tags gem and start adding SEO Nov 3, 2019
test fix breaking specs Nov 3, 2019
tmp init commit 🎉 Jan 25, 2019
.browserslistrc upgrade webpacker Mar 19, 2019
.env Revert "lets try falcon again 🚀" Jun 12, 2019
.gitignore add sitemap indexes to gitignore Oct 26, 2019
.node-version set .node-version to the same version used by Heroku Jun 22, 2019
.ruby-version change ruby version back to 2.6.3 Oct 24, 2019
.standard.yml
CODE_OF_CONDUCT.md Add missing email to Code of Conduct Jul 6, 2019
Gemfile use meta_tags gem and start adding SEO Nov 3, 2019
Gemfile.lock
LICENSE.md
Procfile add webpacker task to Procfile Oct 24, 2019
README.md update project description/readme Oct 5, 2019
Rakefile add standard gem for linting Jan 25, 2019
babel.config.js upgrade webpacker Mar 19, 2019
config.ru add standard gem for linting Jan 25, 2019
docker-compose.yml update elasticsearch Sep 17, 2019
package.json Bump tailwindcss from 1.1.2 to 1.1.3 Oct 22, 2019
postcss.config.js finish off initial dark mode Nov 3, 2019
tailwind.config.js start on dark mode Nov 3, 2019
yarn.lock Bump tailwindcss from 1.1.2 to 1.1.3 Oct 22, 2019

README.md

Ruby API: Easily Find Ruby documentation

View performance data on Skylight

Ruby API is a Ruby on Rails app that makes browsing and searching Ruby's documentation easy and fast for users.

Why?

Trying to find documentation about that one Ruby method or class you're looking for can be pretty tedious. The current goto places for Ruby documentation - ruby-doc.org & docs.ruby-lang.org offer only basic searching and are not designed for mobile devices. Other apps for searching Ruby's documentation such as Dash, while a much better experience, is a paid application (for the full experience) and is only available on devices running MacOS & iOS.

Ruby API aims to improve the Ruby ecosystem by providing an application that is:

  • Available to any device with a web browser and internet connection
  • Designed for mobile devices in mind
  • Optimised for searching common Ruby classes/methods
  • Optimised for Google/Search engines to understand how to index Ruby's documentation.
  • Free. No ads. ever.

Getting started

Install dependencies:

$ bundle install && yarn install

Start ElasticSearch:

$ docker-compose up -d

Start the Rails Server

$ ./bin/rails server

Optionally, you also may want to start the webpack dev server

$ ./bin/webpack

Importing Documentation

Ruby's documentation can be imported very easily. There's a rake task that will let you import a given versions' documentation:

$ ./bin/rake import:ruby[2.6.4]

Running tests

The test suite can be executed with:

$ ./bin/rake test

Code Of Conduct

Everyone interacting with the source code, issue trackers, chat rooms, and mailing lists is expected to follow the Code Of Conduct

License

Ruby API is licensed under the MIT license.

You can’t perform that action at this time.