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

Merge pull request #170 from JohnLyman/markdown-compatibility 

(PDOC-233) markdown whitespace fixes
This commit is contained in:
Eric Putnam 2018-04-03 02:22:24 -07:00 committed by GitHub
parent 6eec1544f7 6ba0350928
commit a4e915002b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 76 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
lib/puppet-strings/markdown/templates/classes_and_defines.erb
View File

@ -2,14 +2,12 @@
<% if text -%> <% if text -%>
<%= text %> <%= text %>
<% elsif summary -%> <% elsif summary -%>
<%= summary %> <%= summary %>
<% else -%> <% else -%>
<%= "The #{name} class." %> <%= "The #{name} class." %>
<% end -%> <% end -%>
<% if since -%> <% if since -%>
* **Since** <%= since %> * **Since** <%= since %>
@ -17,22 +15,28 @@
<% if see -%> <% if see -%>
* **See also** * **See also**
<% see.each do |sa| -%> <% see.each do |sa| -%>
<% if sa[:name] -%>
<%= sa[:name] %> <%= sa[:name] %>
<% end -%>
<% if sa[:text] -%>
<%= sa[:text] %> <%= sa[:text] %>
<% end -%> <% end -%>
<% end -%>
<% end -%> <% end -%>
<% if examples -%> <% if examples -%>
#### Examples #### Examples
<% examples.each do |eg| -%> <% examples.each do |eg| -%>
##### <%= eg[:name] %> ##### <%= eg[:name] %>
```puppet ```puppet
<%= eg[:text] %> <%= eg[:text] %>
``` ```
<% end -%> <% end -%>
<% end -%> <% end -%>
<% if params %> <% if params -%>
#### Parameters #### Parameters
The following parameters are available in the `<%= name %>` <%= @type %>. The following parameters are available in the `<%= name %>` <%= @type %>.
@ -60,4 +64,3 @@ Default value: <%= value_string(defaults[param[:name]]) %>
<% end -%> <% end -%>
<% end -%> <% end -%>
<% end -%> <% end -%>

5
lib/puppet-strings/markdown/templates/function.erb
View File

@ -1,16 +1,15 @@
### <%= name %> ### <%= name %>
Type: <%= type %> Type: <%= type %>
<% if text -%> <% if text -%>
<%= text %> <%= text %>
<% elsif summary -%> <% elsif summary -%>
<%= summary %> <%= summary %>
<% else -%> <% else -%>
<%= "The #{name} class." %> <%= "The #{name} class." %>
<% end -%> <% end -%>
<% signatures.each do |sig| -%> <% signatures.each do |sig| -%>
#### `<%= sig.signature %>` #### `<%= sig.signature %>`

14
lib/puppet-strings/markdown/templates/resource_type.erb
View File

@ -2,14 +2,12 @@
<% if text -%> <% if text -%>
<%= text %> <%= text %>
<% elsif summary -%> <% elsif summary -%>
<%= summary %> <%= summary %>
<% else -%> <% else -%>
<%= "The #{name} type." %> <%= "The #{name} type." %>
<% end -%> <% end -%>
<% if since -%> <% if since -%>
* **Since** <%= since %> * **Since** <%= since %>
@ -17,21 +15,28 @@
<% if see -%> <% if see -%>
* **See also** * **See also**
<% see.each do |sa| -%> <% see.each do |sa| -%>
<% if sa[:name] -%>
<%= sa[:name] %> <%= sa[:name] %>
<% end -%>
<% if sa[:text] -%>
<%= sa[:text] %> <%= sa[:text] %>
<% end -%> <% end -%>
<% end -%>
<% end -%> <% end -%>
<% if examples -%> <% if examples -%>
#### Examples #### Examples
<% examples.each do |eg| -%> <% examples.each do |eg| -%>
##### <%= eg[:name] %> ##### <%= eg[:name] %>
```puppet ```puppet
<%= eg[:text] %> <%= eg[:text] %>
``` ```
<% end -%> <% end -%>
<% end -%> <% end -%>
<% if properties %> <% if properties -%>
#### Properties #### Properties
The following properties are available in the `<%= name %>` <%= @type %>. The following properties are available in the `<%= name %>` <%= @type %>.
@ -111,4 +116,3 @@ Default value: <%= value_string(param[:default]) %>
<% end -%> <% end -%>
<% end -%> <% end -%>
<% end -%> <% end -%>

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

@ -1,13 +1,17 @@
<% if group.length > 0 -%> <% if group.length > 0 -%>
## <%= group_name %> ## <%= group_name %>
<% if priv -%> <% if priv -%>
### Public <%= group_name %> ### Public <%= group_name %>
<% group.each do |item| -%> <% group.each do |item| -%>
<% unless item[:private] -%> <% unless item[:private] -%>
* [`<%= item[:name] %>`](#<%= item[:link] %>): <%= item[:desc] %> * [`<%= item[:name] %>`](#<%= item[:link] %>): <%= item[:desc] %>
<% end -%> <% end -%>
<% end -%> <% end -%>
### Private <%= group_name %> ### Private <%= group_name %>
<% group.each do |item| -%> <% group.each do |item| -%>
<% if item[:private] -%> <% if item[:private] -%>
* `<%= item[:name] %>`: <%= item[:desc] %> * `<%= item[:name] %>`: <%= item[:desc] %>
@ -18,4 +22,5 @@
* [`<%= item[:name] %>`](#<%= item[:link] %>): <%= item[:desc] %> * [`<%= item[:name] %>`](#<%= item[:link] %>): <%= item[:desc] %>
<% end -%> <% end -%>
<% end -%> <% end -%>
<% end -%> <% end -%>

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

@ -1,22 +1,35 @@
# Reference # Reference
## Classes ## Classes
### Public Classes ### Public Classes
* [`klass`](#klass): A simple class. * [`klass`](#klass): A simple class.
### Private Classes ### Private Classes
* `noparams`: Overview for class noparams * `noparams`: Overview for class noparams
## Defined types ## Defined types
* [`klass::dt`](#klassdt): A simple defined type. * [`klass::dt`](#klassdt): A simple defined type.
## Resource types ## Resource types
* [`apt_key`](#apt_key): Example resource type using the new API. * [`apt_key`](#apt_key): Example resource type using the new API.
* [`database`](#database): An example database server type. * [`database`](#database): An example database server type.
## Functions ## Functions
* [`func`](#func): A simple Puppet function. * [`func`](#func): A simple Puppet function.
* [`func3x`](#func3x): Documentation for an example 3.x function. * [`func3x`](#func3x): Documentation for an example 3.x function.
* [`func4x`](#func4x): An example 4.x function. * [`func4x`](#func4x): An example 4.x function.
* [`func4x_1`](#func4x_1): An example 4.x function with only one signature. * [`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. * [`(stdin)`](#(stdin)): Allows you to backup your database to local file.
## Classes ## Classes
### klass ### klass
@ -28,9 +41,10 @@ An overview for a simple class.
* **See also** * **See also**
www.puppet.com www.puppet.com
#### Examples #### Examples
##### This is an example ##### This is an example
```puppet ```puppet
class { 'klass': class { 'klass':
param1 => 1, param1 => 1,
@ -39,6 +53,7 @@ class { 'klass':
``` ```
##### This is another example ##### This is another example
```puppet ```puppet
class { 'klass': class { 'klass':
param1 => 1, param1 => 1,
@ -46,7 +61,6 @@ class { 'klass':
} }
``` ```
#### Parameters #### Parameters
The following parameters are available in the `klass` class. The following parameters are available in the `klass` class.
@ -80,7 +94,6 @@ Third param.
Default value: 'hi' Default value: 'hi'
## Defined types ## Defined types
### klass::dt ### klass::dt
@ -92,9 +105,10 @@ An overview for a simple defined type.
* **See also** * **See also**
www.puppet.com www.puppet.com
#### Examples #### Examples
##### Here's an example of this type: ##### Here's an example of this type:
```puppet ```puppet
klass::dt { 'foo': klass::dt { 'foo':
param1 => 33, param1 => 33,
@ -102,7 +116,6 @@ klass::dt { 'foo':
} }
``` ```
#### Parameters #### Parameters
The following parameters are available in the `klass::dt` defined type. The following parameters are available in the `klass::dt` defined type.
@ -142,7 +155,6 @@ Fourth param.
Default value: `true` Default value: `true`
## Resource types ## Resource types
### apt_key ### apt_key
@ -155,7 +167,9 @@ If Puppet is given the location of a key file which looks like an absolute
path this type will autorequire that file. path this type will autorequire that file.
#### Examples #### Examples
##### here's an example ##### here's an example
```puppet ```puppet
apt_key { '6F6B15509CF8E59E6E469F327F438280EF8D349F': apt_key { '6F6B15509CF8E59E6E469F327F438280EF8D349F':
source => 'http://apt.puppetlabs.com/pubkey.gpg' source => 'http://apt.puppetlabs.com/pubkey.gpg'
@ -191,13 +205,14 @@ _*this data type contains a regex that may not be accurately reflected in genera
The ID of the key you want to manage. The ID of the key you want to manage.
### database ### database
An example database server type. An example database server type.
#### Examples #### Examples
##### here's an example ##### here's an example
```puppet ```puppet
database { 'foo': database { 'foo':
address => 'qux.baz.bar', address => 'qux.baz.bar',
@ -252,10 +267,10 @@ Whether or not to encrypt the database.
Default value: `false` Default value: `false`
## Functions ## Functions
### func ### func
Type: Puppet Language Type: Puppet Language
A simple Puppet function. A simple Puppet function.
@ -292,6 +307,7 @@ Options:
* **:param3opt** `Array`: Something about this option * **:param3opt** `Array`: Something about this option
### func3x ### func3x
Type: Ruby 3.x API Type: Ruby 3.x API
Documentation for an example 3.x function. Documentation for an example 3.x function.
@ -315,6 +331,7 @@ Data type: `Integer`
The second parameter. The second parameter.
### func4x ### func4x
Type: Ruby 4.x API Type: Ruby 4.x API
An example 4.x function. An example 4.x function.
@ -367,6 +384,7 @@ Data type: `Callable`
The block parameter. The block parameter.
### func4x_1 ### func4x_1
Type: Ruby 4.x API Type: Ruby 4.x API
An example 4.x function with only one signature. An example 4.x function with only one signature.

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

@ -1,22 +1,35 @@
# Reference # Reference
## Classes ## Classes
### Public Classes ### Public Classes
* [`klass`](#klass): A simple class. * [`klass`](#klass): A simple class.
### Private Classes ### Private Classes
* `noparams`: Overview for class noparams * `noparams`: Overview for class noparams
## Defined types ## Defined types
* [`klass::dt`](#klassdt): A simple defined type. * [`klass::dt`](#klassdt): A simple defined type.
## Resource types ## Resource types
* [`apt_key`](#apt_key): Example resource type using the new API. * [`apt_key`](#apt_key): Example resource type using the new API.
* [`database`](#database): An example database server type. * [`database`](#database): An example database server type.
## Functions ## Functions
* [`func`](#func): A simple Puppet function. * [`func`](#func): A simple Puppet function.
* [`func3x`](#func3x): Documentation for an example 3.x function. * [`func3x`](#func3x): Documentation for an example 3.x function.
* [`func4x`](#func4x): An example 4.x function. * [`func4x`](#func4x): An example 4.x function.
* [`func4x_1`](#func4x_1): An example 4.x function with only one signature. * [`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. * [`(stdin)`](#(stdin)): Allows you to backup your database to local file.
## Classes ## Classes
### klass ### klass
@ -28,9 +41,10 @@ An overview for a simple class.
* **See also** * **See also**
www.puppet.com www.puppet.com
#### Examples #### Examples
##### This is an example ##### This is an example
```puppet ```puppet
class { 'klass': class { 'klass':
param1 => 1, param1 => 1,
@ -39,6 +53,7 @@ class { 'klass':
``` ```
##### This is another example ##### This is another example
```puppet ```puppet
class { 'klass': class { 'klass':
param1 => 1, param1 => 1,
@ -46,7 +61,6 @@ class { 'klass':
} }
``` ```
#### Parameters #### Parameters
The following parameters are available in the `klass` class. The following parameters are available in the `klass` class.
@ -80,7 +94,6 @@ Third param.
Default value: 'hi' Default value: 'hi'
## Defined types ## Defined types
### klass::dt ### klass::dt
@ -92,9 +105,10 @@ An overview for a simple defined type.
* **See also** * **See also**
www.puppet.com www.puppet.com
#### Examples #### Examples
##### Here's an example of this type: ##### Here's an example of this type:
```puppet ```puppet
klass::dt { 'foo': klass::dt { 'foo':
param1 => 33, param1 => 33,
@ -102,7 +116,6 @@ klass::dt { 'foo':
} }
``` ```
#### Parameters #### Parameters
The following parameters are available in the `klass::dt` defined type. The following parameters are available in the `klass::dt` defined type.
@ -142,7 +155,6 @@ Fourth param.
Default value: `true` Default value: `true`
## Resource types ## Resource types
### apt_key ### apt_key
@ -155,7 +167,9 @@ If Puppet is given the location of a key file which looks like an absolute
path this type will autorequire that file. path this type will autorequire that file.
#### Examples #### Examples
##### here's an example ##### here's an example
```puppet ```puppet
apt_key { '6F6B15509CF8E59E6E469F327F438280EF8D349F': apt_key { '6F6B15509CF8E59E6E469F327F438280EF8D349F':
source => 'http://apt.puppetlabs.com/pubkey.gpg' source => 'http://apt.puppetlabs.com/pubkey.gpg'
@ -191,13 +205,14 @@ _*this data type contains a regex that may not be accurately reflected in genera
The ID of the key you want to manage. The ID of the key you want to manage.
### database ### database
An example database server type. An example database server type.
#### Examples #### Examples
##### here's an example ##### here's an example
```puppet ```puppet
database { 'foo': database { 'foo':
address => 'qux.baz.bar', address => 'qux.baz.bar',
@ -252,10 +267,10 @@ Whether or not to encrypt the database.
Default value: `false` Default value: `false`
## Functions ## Functions
### func ### func
Type: Puppet Language Type: Puppet Language
A simple Puppet function. A simple Puppet function.
@ -292,6 +307,7 @@ Options:
* **:param3opt** `Array`: Something about this option * **:param3opt** `Array`: Something about this option
### func3x ### func3x
Type: Ruby 3.x API Type: Ruby 3.x API
Documentation for an example 3.x function. Documentation for an example 3.x function.
@ -315,6 +331,7 @@ Data type: `Integer`
The second parameter. The second parameter.
### func4x ### func4x
Type: Ruby 4.x API Type: Ruby 4.x API
An example 4.x function. An example 4.x function.
@ -367,6 +384,7 @@ Data type: `Callable`
The block parameter. The block parameter.
### func4x_1 ### func4x_1
Type: Ruby 4.x API Type: Ruby 4.x API
An example 4.x function with only one signature. An example 4.x function with only one signature.
@ -423,7 +441,6 @@ Path to file you want backup to
A simple plan. A simple plan.
#### Parameters #### Parameters
The following parameters are available in the `plann` plan. The following parameters are available in the `plann` plan.
@ -448,4 +465,3 @@ Third param.
Default value: 1 Default value: 1