Skip to content
This repository was archived by the owner on Dec 28, 2023. It is now read-only.

Commit 7f086b5

Browse files
committed
feat: support resource explanation rendering
Support resource explanation rendering of rspec api documentation. See more details in zipmark/rspec_api_documentation#269 .
1 parent 93cdad1 commit 7f086b5

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

app/views/apitome/docs/_all_examples.html.erb

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
<% resources.each do |resource| %>
22
<section class="example" id="<%= id_for(resource['name']) %>">
33
<h1 class="resource-name"><%= resource['name'] %></h1>
4+
5+
<%= render partial: 'resource_explanation', locals: {explanation: resource['explanation']} if resource['explanation'] %>
6+
47
<% resource['examples'].each do |example| %>
58
<% link = example['link'].gsub('.json', '') %>
69
<article id="<%= id_for(link) %>">
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<article class="resource_explanation">
2+
<%= raw rendered_markdown(explanation.strip_heredoc) %>
3+
</article>

0 commit comments

Comments
 (0)