Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rubyapi/rubyapi
Ruby API makes it easy and fast to search or browse the Ruby language API docs
https://github.com/rubyapi/rubyapi
documentation rails-application ruby ruby-api
Last synced: 5 days ago
JSON representation
Ruby API makes it easy and fast to search or browse the Ruby language API docs
- Host: GitHub
- URL: https://github.com/rubyapi/rubyapi
- Owner: rubyapi
- License: mit
- Created: 2019-01-15T12:20:46.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-10-28T18:53:17.000Z (about 2 months ago)
- Last Synced: 2024-10-29T14:15:27.051Z (about 2 months ago)
- Topics: documentation, rails-application, ruby, ruby-api
- Language: HTML
- Homepage: https://rubyapi.org
- Size: 5.43 MB
- Stars: 553
- Watchers: 12
- Forks: 31
- Open Issues: 60
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Ruby API: Easily Find Ruby documentation
[](https://oss.skylight.io/app/applications/k1noEyWLdXuJ)
[](https://github.com/rubyapi/rubyapi/actions?query=workflow%3ACI+branch%3Amain)
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](http://kapeli.com/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
### Github Dev Container
For a quick, easy and automated way to get started, you can use the [Github Dev Container](https://docs.github.com/en/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers).
Github Dev Containers will automatically install all the dependencies and start the application.
[](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=165846166&machine=basicLinux32gb&devcontainer_path=.devcontainer%2Fdevcontainer.json&location=EastUs)
### Local Machine
Install dependencies:
_Note: This command can also be used to quickly update the application dependencies_
```sh
bin/setup
```
Start ElasticSearch:
```sh
docker compose up -d
```
Alternatives to Docker
We only officially support Docker, but you can try with [Podman](https://podman.io) instead:
```sh
podman-compose up -d
```
Start the Rails Server
```sh
bin/dev
```
## Importing Documentation
Ruby's documentation can be imported very easily. There's a rake task that will let you import a given versions' documentation:
```sh
bin/rails import:ruby[3.1]
```
or you can easily import the latest versions of all currently supported versions of Ruby:
```sh
bin/rails import:ruby:all
```
## Running tests
The test suite can be executed with:
```sh
bin/rails test
```
## Linting code
This project uses [StandardRB](https://github.com/standardrb/standard) for linting.
StandardRB can be executed with:
```sh
bin/standardrb
```
_Note: This command may make changes to your code, to make it conform to the formatting rules of
this project._
For instructions on running StandardRB in your editor, [check out StandardRB's Documentation](https://github.com/testdouble/standard#how-do-i-run-standard-in-my-editor).
## Sponsorship
[rubyapi.org](https://rubyapi.org) is supported by [Ruby Central](https://rubycentral.org), a non-profit organization that supports the Ruby community through projects like this one, as well as [RubyGems.org](https://rubygems.org), [RubyConf](https://rubyconf.org), [RailsConf](https://railsconf.org), and [Bundler](https://bundler.io). You can support Ruby Central by attending or [sponsoring]([email protected]) a conference, or by [joining as a supporting member](https://rubycentral.org/#/portal/signup).
Hosting is donated by [Amazon Web Services](https://aws.amazon.com), with CDN service donated by [Fastly](https://fastly.com).
[Learn more about our sponsors and how they work together.](https://rubygems.org/pages/sponsors)
## Code Of Conduct
Everyone interacting with the source code, issue trackers, chat rooms, and mailing lists is expected to follow the [Code Of Conduct](https://github.com/rubyapi/rubyapi/blob/master/CODE_OF_CONDUCT.md)
## License
Ruby API is licensed under the [MIT license](https://github.com/rubyapi/rubyapi/blob/master/LICENSE.md).