Class: RspecApiDocumentation::Views::MarkdownIndex

Inherits:

MarkupIndex

• Object
• Mustache
• MarkupIndex
• RspecApiDocumentation::Views::MarkdownIndex

Defined in:

lib/rspec_api_documentation/views/markdown_index.rb

Direct Known Subclasses

SlateIndex

Instance Method Summary

• #examples ⇒ Object
• #initialize(index, configuration) ⇒ MarkdownIndex constructor

  A new instance of MarkdownIndex.

Methods inherited from MarkupIndex

#sections

Constructor Details

#initialize(index, configuration) ⇒ MarkdownIndex

Returns a new instance of MarkdownIndex.

# File 'lib/rspec_api_documentation/views/markdown_index.rb', line 4

def initialize(index, configuration)
  super
  self.template_name = "rspec_api_documentation/markdown_index"
end

Instance Method Details

#examples ⇒ Object

# File 'lib/rspec_api_documentation/views/markdown_index.rb', line 9

def examples
  @index.examples.map { |example| MarkdownExample.new(example, @configuration) }
end