Sha256: cef77ec51d512bfa4b326522c9242f93108e8788a8b96d1e9dc41bcbac4cb3b7
Contents?: true
Size: 572 Bytes
Versions: 13
Compression:
Stored size: 572 Bytes
Contents
# Renderers
Included renders:
- JSON renderer for https://github.com/twe4ked/api-docs
- Raddocs renderer for https://github.com/smartlogic/raddocs
- Slate renderer for https://github.com/lord/slate
## Protocol
A renderer gets initialized with an array of `Resource`s and then the `render`
instance method is called.
## Example
``` ruby
class ExampleRenderer
def initialize(resources)
@resources = resources
end
def render
puts @resources.map(&:name).join("\n")
end
end
RspecApiDocs.configure do |config|
config.renderer = ExampleRenderer
end
```
Version data entries
13 entries across 13 versions & 1 rubygems