kienan
/
puppet-strings
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

(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.
This commit is contained in:
Eric Putnam 2018-06-03 20:27:05 -07:00
parent abf5c636a0
commit 03b36bcb9f
No known key found for this signature in database
GPG Key ID: 3FB595AA224A7751
4 changed files with 23 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
lib/puppet-strings/markdown/table_of_contents.rb
View File

@ -1,7 +1,7 @@
module PuppetStrings::Markdown
module TableOfContents
def self.render
final = ""
final = "## Table of Contents\n\n"
[PuppetStrings::Markdown::PuppetClasses,
PuppetStrings::Markdown::DefinedTypes,

6
lib/puppet-strings/markdown/templates/table_of_contents.erb
View File

@ -1,8 +1,8 @@
<% 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] -%>

16
spec/fixtures/unit/markdown/output.md vendored
View File

@ -1,33 +1,35 @@
# Reference
<!-- DO NOT EDIT: This document was generated by Puppet Strings -->
## Classes
## Table of Contents
### Public Classes
**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.

18
spec/fixtures/unit/markdown/output_with_plan.md vendored
View File

@ -1,37 +1,39 @@
# Reference
<!-- DO NOT EDIT: This document was generated by Puppet Strings -->
## Classes
## Table of Contents
### Public Classes
**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.