Method: PuppetReadmeGenerator::Generator#markdown

Defined in:
lib/puppet_readme_generator.rb

#markdownObject



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# File 'lib/puppet_readme_generator.rb', line 14

def markdown
  output = []
  output << "# #{puppet_module}\n"
  output << "#### Table of Contents\n"

  count = 1

  unless long_description.nil?
    output << "#{count}. [Description](#description)"
    count += 1
  end

  if classes.length > 0
    output << "#{count}. [Classes](#classes)"
    count += 1
  end

  if defined_types.length > 0
    output << "#{count}. [Defined Types](#defined-types)"
    count += 1
  end

  unless long_description.nil?
    output << '## Description'
    output << long_description
    output << ''
  end

  if classes.length > 0
    output << '## Classes'
    classes.each do |c|
      output << ''
      output << c.markdown
    end
  end

  if defined_types.length > 0
    output << '## DefinedTypes'
    defined_types.each do |dt|
      output << ''
      output << dt.markdown
    end
  end

  output.join("\n")
end