Rspec Api Documentation Browser
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
lib only display Guides section when there are actually guides May 19, 2017
spec Allow guides to be hosted Mar 9, 2016
.gitignore Start documenting with YARD Jun 17, 2014
.travis.yml Use the most recent versions of ruby for travis May 9, 2017
Gemfile Start documenting with YARD Jun 17, 2014
Gemfile.lock Bump version Jul 24, 2017
LICENSE README: Use SVG badge [ci skip] Sep 8, 2017
Rakefile Add a Rakefile Apr 24, 2012
raddocs.gemspec Bump version Jul 24, 2017

Travis status Inline Docs


Raddocs is a browser for JSON outputted by the rspec_api_documentation gem.



gem 'raddocs'


  mount Raddocs::App => "/docs"

Make sure RspecApiDocumentation is generating JSON:


RspecApiDocumentation.configure do |config|
  config.format = :json



  • api_name - Name of the API on the example index page
  • docs_dir - where the JSON output from rspec_api_documentation is located
  • docs_mime_type - if you use the middleware, what mime type are you serving your docs as, must be a regex. eg: /text\/\+plain/
  • include_bootstrap - Boolean to disable including bootstrap if you are using your own css
  • external_css - Array of css files to include, with a full URL to them
  • url_prefix - Optional prefix to insert before URLs generated by Raddocs
Raddocs.configure do |config|
  config.docs_dir = "doc/api"

Custom CSS

You 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.