support for resource 'explanation' property

see: zipmark/rspec_api_documentation#269
tedconf · Sep 7, 2016 · 4a6520d · 4a6520d
1 parent b618c5d
commit 4a6520d
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/app/views/apitome/docs/_all_examples.html.erb b/app/views/apitome/docs/_all_examples.html.erb
@@ -1,6 +1,7 @@
 <% resources.each do |resource| %>
   <section class="example" id="<%= id_for(resource['name']) %>">
     <h1 class="resource-name"><%= resource['name'] %></h1>
+    <%= render partial: 'resource_explanation', locals: { explanation: resource['explanation']} if resource['explanation'] %>
     <% resource['examples'].each do |example| %>
       <% link = example['link'].gsub('.json', '') %>
       <article id="<%= id_for(link) %>">

diff --git a/app/views/apitome/docs/_resource_explanation.html.erb b/app/views/apitome/docs/_resource_explanation.html.erb
@@ -0,0 +1,3 @@
+<article class="resource-explanation explanation">
+  <%= raw rendered_markdown(explanation.strip_heredoc) %>
+</article>