Use tables to represent markdown parameters

Author: ianks

features/markdown_documentation.feature

@@ -226,14 +226,11 @@ Feature: Generate Markdown documentation from test examples
 
     ### Parameters
 
-    Name : name *- required -*
-    Description : Name of order
-
-    Name : amount *- required -*
-    Description : Amount paid
-
-    Name : description
-    Description : Some comments on the order
+    | Name | Description | Required | Scope |
+    |------|-------------|----------|-------|
+    | name | Name of order | true |  |
+    | amount | Amount paid | true |  |
+    | description | Some comments on the order | false |  |
 
     ### Request
 

lib/rspec_api_documentation/views/markdown_example.rb

@@ -8,6 +8,12 @@ def initialize(example, configuration)
         self.template_name = "rspec_api_documentation/markdown_example"
       end
 
+      def parameters
+        super.each do |parameter|
+          parameter[:required] = parameter[:required] ? 'true' : 'false'
+        end
+      end
+
       def extension
         EXTENSION
       end

templates/rspec_api_documentation/markdown_example.mustache

@@ -10,10 +10,11 @@
 {{# has_parameters? }}
 
 ### Parameters
-{{# parameters }}
 
-Name : {{ name }}{{# required }} *- required -*{{/ required }}
-Description : {{ description }}
+| Name | Description | Required | Scope |
+|------|-------------|----------|-------|
+{{# parameters }}
+| {{ name }} | {{ description }} | {{ required }} | {{ scope }} |
 {{/ parameters }}
 
 {{/ has_parameters? }}