Allow raw input(html/markdown/textile) from api_description

GenomeUS · Aug 17, 2017 · ed281e8 · ed281e8
1 parent 00d4360
commit ed281e8
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git a/features/html_documentation.feature b/features/html_documentation.feature
@@ -24,7 +24,7 @@ Feature: Generate HTML documentation from test examples
       RspecApiDocumentation.configure do |config|
         config.app = App
         config.api_name = "Example API"
-        config.api_explanation = "Example API Description"
+        config.api_explanation = "<p>Example API Description</p>"
         config.request_headers_to_include = %w[Cookie]
         config.response_headers_to_include = %w[Content-Type]
       end

diff --git a/templates/rspec_api_documentation/html_index.mustache b/templates/rspec_api_documentation/html_index.mustache
@@ -10,7 +10,7 @@
 <body>
 <div class="container">
   <h1>{{ api_name }}</h1>
-  {{ api_explanation }}
+  {{{ api_explanation }}}
   {{# sections }}
   <div class="article">
     <h2>{{ resource_name }}</h2>

diff --git a/templates/rspec_api_documentation/markdown_index.mustache b/templates/rspec_api_documentation/markdown_index.mustache
@@ -1,5 +1,5 @@
 # {{ api_name }}
-{{ api_explanation }}
+{{{ api_explanation }}}
 
 {{# sections }}
 ## {{ resource_name }}

diff --git a/templates/rspec_api_documentation/textile_index.mustache b/templates/rspec_api_documentation/textile_index.mustache
@@ -1,5 +1,5 @@
 h1. {{ api_name }}
-{{ api_explanation }}
+{{{ api_explanation }}}
 
 {{# sections }}
 h2. {{ resource_name }}