Skip to content
Ruby API makes it easy and fast to search or browse the Ruby language API docs
Ruby HTML JavaScript CSS
Branch: master
Clone or download

Latest commit

JuanitoFatas Merge pull request #303 from rubyapi/dependabot/bundler/nokogiri-1.10.8
[Security] Bump nokogiri from 1.10.7 to 1.10.8
Latest commit 9e3c2a7 Feb 25, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/workflows cache gems in Github Actions Jan 25, 2020
app
bin upgrade webpacker Mar 19, 2019
config add ruby 2.7 and set as default Dec 25, 2019
lib add code runtime experimental feature Dec 18, 2019
log init commit 🎉 Jan 25, 2019
public use meta_tags gem and start adding SEO Nov 3, 2019
test make standardrb happy Dec 12, 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 update ruby Jan 25, 2020
.standard.yml
CODE_OF_CONDUCT.md Add missing email to Code of Conduct Jul 6, 2019
Gemfile update ruby Jan 25, 2020
Gemfile.lock [Security] Bump nokogiri from 1.10.7 to 1.10.8 Feb 24, 2020
LICENSE.md add MIT license Jan 25, 2019
Procfile set number of falcon instances to 4 Dec 16, 2019
README.md add rake task to import documentation from all the latest versions of Dec 9, 2019
Rakefile add standard gem for linting Jan 25, 2019
babel.config.js
config.ru
docker-compose.yml update elasticsearch Sep 17, 2019
package.json Bump mustache from 3.1.0 to 4.0.0 Feb 22, 2020
postcss.config.js allow code styles in purgecss Nov 22, 2019
tailwind.config.js
yarn.lock Bump mustache from 3.1.0 to 4.0.0 Feb 22, 2020

README.md

Ruby API: Easily Find Ruby documentation

View performance data on Skylight

Ruby API makes it easy and fast to search or browse the Ruby language API docs.

Why?

The existing websites for Ruby documentation are hard to search, and impossible to read on mobile devices. Ruby API provides instant search results, inspired by Dash, and a responsive design that's easy to read on any size device.

We aim to improve the Ruby ecosystem by being:

  • Readable on any size device
  • Fast on any speed internet connection
  • Relevant search results that surface useful APIs
  • Search engine optimized pages for every API method
  • Free, with 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-dev-server

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]

or you can easily import the latest versions of all currently supported versions of ruby:

$ ./bin/rake import:ruby:all

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.