rain-doc 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df089a5bc4bd8767575912bd945d21d61e1f130a
-  data.tar.gz: 5bcfac44baee8a2e7181c5fca1c64b93218d4ae3
+  metadata.gz: 92ea5b3512a732bd0fe45d4352ffc26ab76d68ba
+  data.tar.gz: 141fd51fb9902ab6fb6d4ded0505a6c80ee3e55c
 SHA512:
-  metadata.gz: 1d92bc03a756b62a923691850b12553360a721460df0549cf91a64f20312f846625468c25d158b296f066932cd4bcb51748b9a9412891f133b8e2565a4a8231c
-  data.tar.gz: 7205b1029816eb138f513e7efe6d710242db5c1a78e4979c1d0ae658c17e0eb0ae2b4bce7c5ef94a218b8f47f495da168b5ffc3142949a05a00abf563758366e
+  metadata.gz: 863f0f4e70124d1a8df0534d5ae2b83fc8a77cfbdd4e7cbba8c7d73e92fc502b2fcae7e64b0ff8e8ca9d120594cb054b2b3c49c9bea30ebf18c0e95fe7a4f6ce
+  data.tar.gz: 8cc352acd390172c7f210429c4f5680fb374d09c40bd8b8ab07b1d40d8a838aac3d252f572b2b4d4821cecc54dfaaabe8364e1485bf84148de2fbb5579ec681b

data/lib/output.rb

@@ -1,3 +1,5 @@
+require 'redcarpet'
+
 module Rain
   class Output
 
@@ -56,6 +58,12 @@ module Rain
 
         # create an openstruct from the current doc and render into the template
         doc_os = OpenStruct.new(doc.to_hash)
+
+        # convert the doc lines from each of the doc parts
+        # from markdown to HTML.
+        doc_os = doc_to_markdown(doc_os)
+
+        # render the doc into the ERB template.
         doc_rendered = ERB.new(doc_template).result(doc_os.instance_eval {binding})
 
         # create a struct with the rendered doc output then render into the layout with nav
@@ -176,5 +184,28 @@ module Rain
       File.open("./rain_out/#{file_name}", 'w') { |file| file.write(html) }
     end
 
+    def doc_to_markdown(doc)
+
+      # loop through all of the doc pars
+      markdown_renderer = Redcarpet::Markdown.new(Redcarpet::Render::HTML, tables: true, fenced_code_blocks: true)
+      doc[:parts].each do |part|
+
+        # join the lines and render with markdown.
+        part[:markdown] = markdown_renderer.render(part[:doc].join("\n"))
+
+        # loop through all of the params and render their markdown
+        part[:params].each do |param|
+          param[:markdown] = markdown_renderer.render(param[:text].join("\n"))
+        end
+
+        # loop through all of the headers and render their markdown
+        part[:headers].each do |header|
+          header[:markdown] = markdown_renderer.render(header[:text].join("\n"))
+        end
+      end
+
+      doc
+    end
+
   end
 end

data/templates/css/rain.css

@@ -35,6 +35,20 @@ p {
   background-color: #e54400;
 }
 
+/* Styles to make rendered markdown output fonts smaller than defaults, to avoid gigantic headers etc. */
+.rain-doc-markdown p,
+.rain-doc-markdown h1, .rain-doc-markdown h2, .rain-doc-markdown h3,
+.rain-doc-markdown h4, .rain-doc-markdown h5, .rain-doc-markdown h6 {
+  font-size: 1.2em;
+}
+.rain-doc-markdown h1 { font-size: 2em; }
+.rain-doc-markdown h2 { font-size: 1.8em; }
+.rain-doc-markdown h3 { font-size: 1.6em; }
+.rain-doc-markdown h4 { font-size: 1.4em; }
+.rain-doc-markdown h5 { font-size: 1.2em; }
+.rain-doc-markdown h6 { font-size: 1em; }
+.rain-doc-markdown table > tbody > tr > td > p { font-size: 1em !important; margin: 0 !important; }
+
 /* Footer and rain version information styles */
 .rain-version-info {
   text-align: center;

data/templates/doc.erb

@@ -14,13 +14,13 @@
   <% end %>
 
   <!-- display all of the docs together for the doc_part -->
-  <p><% doc_part[:doc].each do |doc| %>
-    <%= doc %>&nbsp;
-  <% end %></p>
+  <div class="rain-doc-markdown">
+    <%= doc_part[:markdown] %>
+  </p>
 
   <!-- show all of the params in a table -->
   <% if doc_part[:params].length > 0 %>
-    <h5>Parameters</h5>
+    <h4>Parameters</h4>
     <table class="u-full-width">
       <thead>
         <tr>
@@ -35,7 +35,7 @@
           <td><%= param[:name] %></td>
           <td><%= param[:type] %></td>
           <td><%= param[:default].nil? ? 'N/A' : param[:default] %></td>
-          <td><%= param[:text].join(' ') %></td>
+          <td><%= param[:markdown] %></td>
         </tr>
       <% end %>
     </table>
@@ -43,7 +43,7 @@
 
   <!-- show all of the headers in a table -->
   <% if doc_part[:headers].length > 0 %>
-    <h5>Headers</h5>
+    <h4>Headers</h4>
     <table class="u-full-width">
       <thead>
         <tr>
@@ -51,10 +51,10 @@
           <th>Description</th>
         </tr>
       </thead>
-      <% doc_part[:headers].each do |param| %>
+      <% doc_part[:headers].each do |header| %>
         <tr>
-          <td><%= param[:name] %></td>
-          <td><%= param[:text].join(' ') %></td>
+          <td><%= header[:name] %></td>
+          <td><%= header[:markdown] %></td>
         </tr>
       <% end %>
     </table>
@@ -62,7 +62,7 @@
 
   <!-- show all of the responses with examples -->
   <% if doc_part[:responses].length > 0 %>
-    <h5>Response Examples</h5>
+    <h4>Response Examples</h4>
     <% doc_part[:responses].each do |response| %>
       <p><strong><%= response[:code] %></strong> <%= response[:id].upcase %></p>
       <pre><code><%= response[:text].join("\n") %></code></pre>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rain-doc
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Martin Brennan
@@ -52,6 +52,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.2
 description: "Rain is a gem to generate beautiful and customizable API documentation,
   inspired by yard and rdoc.                    The aim of Rain is to generate beautiful
   API documentation from a ruby comment syntax with markdown mixed in.  \n                   The