(#242) Wrap names in backticks when rendering to markdown

Updates the markdown templates to wrap many resource and value names in
backticks to prevent emoji from being inadvertantly rendered when a
resource name contains a namespace that happens to also be an emoji
sequence on Github et. al.

Author: scotje

lib/puppet-strings/markdown/templates/classes_and_defines.erb

@@ -1,4 +1,4 @@
-### <%= name %>
+### `<%= name %>`
 
 <% if text -%>
 <%= text %>
@@ -75,7 +75,7 @@ Options:
 
 <% end -%>
 <% if defaults && defaults[param[:name]] -%>
-Default value: <%= value_string(defaults[param[:name]]) %>
+Default value: `<%= value_string(defaults[param[:name]]) %>`
 
 <% end -%>
 <% end -%>

lib/puppet-strings/markdown/templates/data_type.erb

@@ -1,4 +1,4 @@
-### <%= name %>
+### `<%= name %>`
 
 <% if text -%>
 <%= text %>
@@ -79,7 +79,7 @@ Options:
 
 <% end -%>
 <% if defaults && defaults[param[:name]] -%>
-Default value: <%= value_string(defaults[param[:name]]) %>
+Default value: `<%= value_string(defaults[param[:name]]) %>`
 
 <% end -%>
 <% end -%>

lib/puppet-strings/markdown/templates/data_type_function.erb

@@ -1,4 +1,4 @@
-### <%= name %>
+### `<%= name %>`
 
 #### `<%= signature %>`
 

lib/puppet-strings/markdown/templates/function.erb

@@ -1,4 +1,4 @@
-### <%= name %>
+### `<%= name %>`
 
 Type: <%= type %>
 

lib/puppet-strings/markdown/templates/puppet_task.erb

@@ -1,4 +1,4 @@
-### <%= name %>
+### `<%= name %>`
 
 <% if text -%>
 <%= text %>

lib/puppet-strings/markdown/templates/resource_type.erb

@@ -1,4 +1,4 @@
-### <%= name %>
+### `<%= name %>`
 
 <% if text -%>
 <%= text %>
@@ -53,15 +53,15 @@ The following properties are available in the `<%= name %>` <%= @type %>.
 ##### `<%= prop[:name] %>`
 
 <% if prop[:values] -%>
-Valid values: <%= prop[:values].map { |value| value_string(value) }.join(', ') %>
+Valid values: `<%= prop[:values].map { |value| value_string(value) }.join('`, `') %>`
 
 <% end -%>
 <% if prop[:isnamevar] -%>
 namevar
 
 <% end -%>
 <% if prop[:aliases] -%>
-Aliases: <%= prop[:aliases].to_s.delete('{').delete('}') %>
+Aliases: `<%= prop[:aliases].to_s.delete('{').delete('}') %>`
 
 <% end -%>
 <% if prop[:data_type] -%>
@@ -87,7 +87,7 @@ Options:
 
 <% end -%>
 <% if prop[:default] -%>
-Default value: <%= prop[:default] %>
+Default value: `<%= prop[:default] %>`
 
 <% end -%>
 <% end -%>
@@ -101,15 +101,15 @@ The following parameters are available in the `<%= name %>` <%= @type %>.
 ##### `<%= param[:name] %>`
 
 <% if param[:values] -%>
-Valid values: <%= param[:values].map { |value| value_string(value) }.join(', ') %>
+Valid values: `<%= param[:values].map { |value| value_string(value) }.join('`, `') %>`
 
 <% end -%>
 <% if param[:isnamevar] -%>
 namevar
 
 <% end -%>
 <% if param[:aliases] -%>
-Aliases: <%= param[:aliases].to_s.delete('{').delete('}') %>
+Aliases: `<%= param[:aliases].to_s.delete('{').delete('}') %>`
 
 <% end -%>
 <% if param[:data_type] -%>
@@ -135,7 +135,7 @@ Options:
 
 <% end -%>
 <% if param[:default] -%>
-Default value: <%= value_string(param[:default]) %>
+Default value: `<%= value_string(param[:default]) %>`
 
 <% end -%>
 <% if param[:required_features] -%>

spec/unit/puppet-strings/markdown_spec.rb

@@ -133,7 +133,7 @@ def parse_data_type_content
         end
 
         it 'includes param default' do
-          expect(output).to match(/default value: param2/i)
+          expect(output).to match(/default value: `param2`/i)
         end
       end