Class: Brief::Briefcase::Documentation::ModelDoc

Inherits:

Object

• Object
• Brief::Briefcase::Documentation::ModelDoc

Defined in:

lib/brief/briefcase/documentation.rb

Instance Method Summary

• #content ⇒ Object
• #initialize(path) ⇒ ModelDoc constructor

  A new instance of ModelDoc.

• #rendered ⇒ Object

Constructor Details

#initialize(path) ⇒ ModelDoc

Returns a new instance of ModelDoc.

# File 'lib/brief/briefcase/documentation.rb', line 6

def initialize(path)
  @content = Pathname(path).read rescue ""
end

Instance Method Details

#content ⇒ Object

# File 'lib/brief/briefcase/documentation.rb', line 10

def content
  @content
end

#rendered ⇒ Object

# File 'lib/brief/briefcase/documentation.rb', line 14

def rendered
  ::GitHub::Markdown.render_gfm(content)
end