(PDOC-255) markdown table of contents update

Markdown output does not currently distinguish between the group headings for the table of contents and group headings in the actual content. This change adds a 'Table of Contents' heading and changes group headings to bold text to make it much more clear that you're looking at the table of contents.
parent abf5c636
module PuppetStrings::Markdown
module TableOfContents
def self.render
final = ""
final = "## Table of Contents\n\n"
[PuppetStrings::Markdown::PuppetClasses,
PuppetStrings::Markdown::DefinedTypes,
......
<% if group.length > 0 -%>
## <%= group_name %>
**<%= group_name %>**
<% if priv -%>
### Public <%= group_name %>
_Public <%= group_name %>_
<% group.each do |item| -%>
<% unless item[:private] -%>
......@@ -10,7 +10,7 @@
<% end -%>
<% end -%>
### Private <%= group_name %>
_Private <%= group_name %>_
<% group.each do |item| -%>
<% if item[:private] -%>
......
# Reference
<!-- DO NOT EDIT: This document was generated by Puppet Strings -->
## Classes
## Table of Contents
**Classes**
### Public Classes
_Public Classes_
* [`klass`](#klass): A simple class.
### Private Classes
_Private Classes_
* `noparams`: Overview for class noparams
## Defined types
**Defined types**
* [`klass::dt`](#klassdt): A simple defined type.
## Resource types
**Resource types**
* [`apt_key`](#apt_key): Example resource type using the new API.
* [`database`](#database): An example database server type.
## Functions
**Functions**
* [`func`](#func): A simple Puppet function.
* [`func3x`](#func3x): Documentation for an example 3.x function.
* [`func4x`](#func4x): An example 4.x function.
* [`func4x_1`](#func4x_1): An example 4.x function with only one signature.
## Tasks
**Tasks**
* [`(stdin)`](#(stdin)): Allows you to backup your database to local file.
......
# Reference
<!-- DO NOT EDIT: This document was generated by Puppet Strings -->
## Classes
## Table of Contents
**Classes**
### Public Classes
_Public Classes_
* [`klass`](#klass): A simple class.
### Private Classes
_Private Classes_
* `noparams`: Overview for class noparams
## Defined types
**Defined types**
* [`klass::dt`](#klassdt): A simple defined type.
## Resource types
**Resource types**
* [`apt_key`](#apt_key): Example resource type using the new API.
* [`database`](#database): An example database server type.
## Functions
**Functions**
* [`func`](#func): A simple Puppet function.
* [`func3x`](#func3x): Documentation for an example 3.x function.
* [`func4x`](#func4x): An example 4.x function.
* [`func4x_1`](#func4x_1): An example 4.x function with only one signature.
## Tasks
**Tasks**
* [`(stdin)`](#(stdin)): Allows you to backup your database to local file.
## Plans
**Plans**
* [`plann`](#plann): A simple plan.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment