{"id":13553896,"url":"https://github.com/smartlogic/raddocs","last_synced_at":"2025-04-06T11:07:25.434Z","repository":{"id":3093811,"uuid":"4118632","full_name":"smartlogic/raddocs","owner":"smartlogic","description":"Rspec Api Documentation Browser","archived":false,"fork":false,"pushed_at":"2025-02-26T21:50:23.000Z","size":242,"stargazers_count":72,"open_issues_count":5,"forks_count":51,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-03-30T10:06:27.604Z","etag":null,"topics":["api","documentation","rspec","ruby"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/smartlogic.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2012-04-23T22:20:38.000Z","updated_at":"2025-02-26T21:11:35.000Z","dependencies_parsed_at":"2023-07-05T20:16:15.718Z","dependency_job_id":null,"html_url":"https://github.com/smartlogic/raddocs","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartlogic%2Fraddocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartlogic%2Fraddocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartlogic%2Fraddocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartlogic%2Fraddocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/smartlogic","download_url":"https://codeload.github.com/smartlogic/raddocs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247471517,"owners_count":20944158,"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":["api","documentation","rspec","ruby"],"created_at":"2024-08-01T12:02:35.563Z","updated_at":"2025-04-06T11:07:25.412Z","avatar_url":"https://github.com/smartlogic.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","documentation"],"sub_categories":[],"readme":"[![Travis status](https://secure.travis-ci.org/smartlogic/raddocs.svg)](https://secure.travis-ci.org/smartlogic/raddocs)\n[![Inline Docs](http://inch-ci.org/github/smartlogic/raddocs.png)](http://inch-ci.org/github/smartlogic/raddocs)\n\n\n# Raddocs\n\nRaddocs is a browser for JSON outputted by the [rspec_api_documentation](http://github.com/zipmark/rspec_api_documentation) gem.\n\n## Install\n\n`Gemfile`\n```ruby\ngem 'raddocs'\n```\n\n`config/routes.rb`\n\n```ruby\n  mount Raddocs::App =\u003e \"/docs\"\n```\n\nMake sure RspecApiDocumentation is generating JSON:\n\n`spec/spec_helper.rb`\n\n```ruby\nRspecApiDocumentation.configure do |config|\n  config.format = :json\nend\n```\n\n\n## Configuration\n\n`config/initializers/raddocs.rb`\n\n* `api_name` - Name of the API on the example index page\n* `docs_dir` - where the JSON output from rspec_api_documentation is located\n* `docs_mime_type` - if you use the middleware, what mime type are you serving your docs as, must be a regex. eg: `/text\\/vnd.org.oestrich.raddocs\\+plain/`\n* `include_bootstrap` - Boolean to disable including bootstrap if you are using your own css\n* `external_css` - Array of css files to include, with a full URL to them\n* `url_prefix` - Optional prefix to insert before URLs generated by Raddocs\n\n```ruby\nRaddocs.configure do |config|\n  config.docs_dir = \"doc/api\"\nend\n```\n\n### Custom CSS\n\nYou can include extra css by the config option `external_css` or add a directory to the docs dir named `styles`. Every css file in the styles dir will be included as a link element on all pages.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmartlogic%2Fraddocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsmartlogic%2Fraddocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmartlogic%2Fraddocs/lists"}