{"id":13514597,"url":"https://github.com/rubyapi/rubyapi","last_synced_at":"2025-04-14T20:56:03.412Z","repository":{"id":37561702,"uuid":"165846166","full_name":"rubyapi/rubyapi","owner":"rubyapi","description":"Ruby API makes it easy and fast to search or browse the Ruby language API docs","archived":false,"fork":false,"pushed_at":"2025-04-10T00:49:41.000Z","size":5634,"stargazers_count":579,"open_issues_count":43,"forks_count":31,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-04-10T01:37:36.890Z","etag":null,"topics":["documentation","rails-application","ruby","ruby-api"],"latest_commit_sha":null,"homepage":"https://rubyapi.org","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rubyapi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-01-15T12:20:46.000Z","updated_at":"2025-04-10T00:47:31.000Z","dependencies_parsed_at":"2024-02-12T05:25:18.936Z","dependency_job_id":"2099c551-5132-4bed-b21b-19d681aa0300","html_url":"https://github.com/rubyapi/rubyapi","commit_stats":{"total_commits":2430,"total_committers":24,"mean_commits":101.25,"dds":0.5769547325102881,"last_synced_commit":"30a422263cc735211da98c9ff47a8f067e043898"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubyapi%2Frubyapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubyapi%2Frubyapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubyapi%2Frubyapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubyapi%2Frubyapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rubyapi","download_url":"https://codeload.github.com/rubyapi/rubyapi/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248961142,"owners_count":21189991,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","rails-application","ruby","ruby-api"],"created_at":"2024-08-01T05:00:58.274Z","updated_at":"2025-04-14T20:56:03.374Z","avatar_url":"https://github.com/rubyapi.png","language":"HTML","readme":"# Ruby API: Easily Find Ruby documentation\n\nRuby API makes it easy and fast to search or browse the Ruby language API docs.\n\n## Why?\n\nThe 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.\n\nWe aim to improve the Ruby ecosystem by being:\n\n* Readable on any size device\n* Fast on any speed internet connection\n* Relevant search results that surface useful APIs\n* Search engine optimized pages for every API method\n* Free, with no ads. Ever.\n\n## Getting started\n\n### Github Dev Container\n\nFor 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).\n\nGithub Dev Containers will automatically install all the dependencies and start the application.\n\n[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true\u0026ref=main\u0026repo=165846166\u0026machine=basicLinux32gb\u0026devcontainer_path=.devcontainer%2Fdevcontainer.json\u0026location=EastUs)\n\n### Local Machine\n\nInstall dependencies:\n\n_Note: This command can also be used to quickly update the application dependencies_\n\n```sh\nbin/setup\n```\n\nStart ElasticSearch:\n\n```sh\ndocker compose up -d\n```\n\n\u003cdetails\u003e\n\u003csummary\u003eAlternatives to Docker\u003c/summary\u003e\n\nWe only officially support Docker, but you can try with [Podman](https://podman.io) instead:\n\n```sh\npodman-compose up -d\n```\n\u003c/details\u003e\n\nStart the Rails Server\n\n```sh\nbin/dev\n```\n\n## Importing Documentation\n\nRuby's documentation can be imported very easily. There's a rake task that will let you import a given versions' documentation:\n\n```sh\nbin/rails import:ruby[3.1]\n```\n\nor you can easily import the latest versions of all currently supported versions of Ruby:\n\n```sh\nbin/rails import:ruby:all\n```\n\n## Running tests\n\nThe test suite can be executed with:\n\n```sh\nbin/rails test\n```\n\n## Linting code\n\nThis project uses [StandardRB](https://github.com/standardrb/standard) for linting.\n\nStandardRB can be executed with:\n\n```sh\nbin/standardrb\n```\n\n_Note: This command may make changes to your code, to make it conform to the formatting rules of\nthis project._\n\nFor 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).\n\n\n## Sponsorship\n\n\u003ca href=\"https://rubycentral.org/\"\u003e\u003cimg src=\"https://rubycentral.org/content/images/size/w256h256/format/png/2022/11/Ruby-Central-logo.svg\" height=110\u003e\u003c/a\u003e\u003cbr/\u003e\n\n[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](sponsors@rubycentral.org) a conference, or by [joining as a supporting member](https://rubycentral.org/#/portal/signup).\n\nHosting is donated by [Amazon Web Services](https://aws.amazon.com), with CDN service donated by [Fastly](https://fastly.com).\n\n[Learn more about our sponsors and how they work together.](https://rubygems.org/pages/sponsors)\n\n## Code Of Conduct\n\nEveryone 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)\n\n## License\n\nRuby API is licensed under the [MIT license](https://github.com/rubyapi/rubyapi/blob/master/LICENSE.md).\n","funding_links":[],"categories":["HTML"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frubyapi%2Frubyapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frubyapi%2Frubyapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frubyapi%2Frubyapi/lists"}