class Jazzy::SourceDocument
Standalone markdown docs including index.html
Attributes
overview[RW]
readme_path[RW]
Public Class Methods
make_index(readme_path)
click to toggle source
# File lib/jazzy/source_document.rb, line 22 def self.make_index(readme_path) SourceDocument.new.tap do |sd| sd.name = 'index' sd.url = sd.name + '.html' sd.readme_path = readme_path end end
new()
click to toggle source
Calls superclass method
# File lib/jazzy/source_document.rb, line 13 def initialize super self.children = [] self.parameters = [] self.abstract = '' self.type = SourceDeclaration::Type.markdown self.mark = SourceMark.new end
Public Instance Methods
config()
click to toggle source
# File lib/jazzy/source_document.rb, line 42 def config Config.instance end
config_readme()
click to toggle source
# File lib/jazzy/source_document.rb, line 60 def config_readme readme_path.read if readme_path&.exist? end
content(source_module)
click to toggle source
# File lib/jazzy/source_document.rb, line 50 def content(source_module) return readme_content(source_module) if name == 'index' overview end
fallback_readme()
click to toggle source
# File lib/jazzy/source_document.rb, line 64 def fallback_readme %w[README.md README.markdown README.mdown README].each do |potential_name| file = config.source_directory + potential_name return file.read if file.exist? end false end
generated_readme(source_module)
click to toggle source
# File lib/jazzy/source_document.rb, line 72 def generated_readme(source_module) if podspec = config.podspec ### License # <a href="#{license[:url]}">#{license[:license]}</a> <<-README # #{podspec.name} ### #{podspec.summary} #{podspec.description} ### Installation ```ruby pod '#{podspec.name}' ``` ### Authors #{source_module.author_name} README else <<-README # #{source_module.readme_title} ### Authors #{source_module.author_name} README end end
omit_content_from_parent?()
click to toggle source
# File lib/jazzy/source_document.rb, line 38 def omit_content_from_parent? true end
readme?()
click to toggle source
# File lib/jazzy/source_document.rb, line 30 def readme? url == 'index.html' end
readme_content(source_module)
click to toggle source
# File lib/jazzy/source_document.rb, line 56 def readme_content(source_module) config_readme || fallback_readme || generated_readme(source_module) end
render_as_page?()
click to toggle source
# File lib/jazzy/source_document.rb, line 34 def render_as_page? true end
url_name()
click to toggle source
# File lib/jazzy/source_document.rb, line 46 def url_name name.downcase.strip.tr(' ', '-').gsub(/[^[[:word:]]-]/, '') end