rdoc-markdown 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f34bf7fc9e0588740713d04925521cfc098ce43b057c16e55ed9bcfb5b16030f
-  data.tar.gz: 2180ab33878a7aa893dd9daded24048319a0670d7c7530789493d41f0fccdd6b
+  metadata.gz: eb88e163756c49396b718459f7d5dafc96350d4326d6fd1e57a13fc3ac011116
+  data.tar.gz: 2a7477e2eb1b98af6cd06933e67f129892a492971b9ce60b64da4d296a42ac18
 SHA512:
-  metadata.gz: 7de709a0032575a1720aa6c99be7ed712471dc02c9c99c5bdcfc2bc8035691d7b633a5431b3575767c648d36b74cf6380e0162085578a59d7367629de902232b
-  data.tar.gz: 4c8ff9eef4209d99aa9034ccf0e7ebaca5cc097316127ff24d4875d327595c28731e1dd44f39bb1f4e5367eead1c1348653d8f2cf5bae80d6d94afd093cf6ded
+  metadata.gz: fa23545b89bfedd7cec08dd8f387727df15fb75c6cc532b35566fcb2ab2e53f85c94c7ec88e364edf59df15c6d2363b8ad3f54ec51627c6b1cac6592c83f2188
+  data.tar.gz: ac8f4cd2f344afb9ac357ecd16202e40c60527e2db149fba53cff7ca55682561082c1a8a56958b914b5ba7c09a5d1c66b40b60b89c87bc51c3e8ef1c1d963987

data/README.md

@@ -19,7 +19,7 @@ RDoc will auto-detect rdoc-markdown plugin if it was installed. You just need to
 
 Run following command in directory with ruby source code:
 
-`rdoc --format=markdown`
+`rdoc --format=markdown --markup=markdown`
 
 This will produce a tree of markdown documents and search index in `/doc` folder. Every class in library will have it's own markdown file.
 

data/lib/rdoc/generator/markdown.rb

@@ -62,6 +62,8 @@ class RDoc::Generator::Markdown
   # Generates markdown files and search index file
 
   def generate
+    # TODO: Make sure to set --markup parameter to 'markdown'.
+
     debug("Setting things up #{@output_dir}")
 
     setup
@@ -70,7 +72,7 @@ class RDoc::Generator::Markdown
 
     emit_classfiles
 
-    debug("Generate index db file: #{output_dir}/index.db")
+    debug("Generate search index in #{output_dir}/index.db")
 
     emit_sqlite
   end
@@ -154,7 +156,7 @@ class RDoc::Generator::Markdown
       out_file = Pathname.new("#{output_dir}/#{turn_to_path klass.full_name}")
       out_file.dirname.mkpath
 
-      result = template.result(binding).squeeze.gsub("\n ", "\n").squeeze("\n")
+      result = template.result(binding).squeeze(" ").gsub("\n ", "\n").squeeze("\n\n")
 
       File.write(out_file, result)
     end
@@ -171,7 +173,14 @@ class RDoc::Generator::Markdown
   # Converts HTML string into a Markdown string with some cleaning and improvements.
 
   def markdownify(input)
-    md = ReverseMarkdown.convert input
+    # TODO: I should be able to set unknown_tags to "raise" for debugging purposes. Probably through rdoc parameters?
+    # Allowed parameters:
+    # - pass_through - (default) Include the unknown tag completely into the result
+    # - drop - Drop the unknown tag and its content
+    # - bypass - Ignore the unknown tag but try to convert its content
+    # - raise - Raise an error to let you know
+
+    md = ReverseMarkdown.convert input, unknown_tags: :pass_through, github_flavored: true
 
     # unintent multiline strings
     md.unindent!
@@ -182,6 +191,8 @@ class RDoc::Generator::Markdown
 
       "[#{match[1]}](#{match[2]}.md#{match[3]})"
     end
+
+    md.gsub("=== ", "### ").gsub("== ", "## ")
   end
 
   # Aliasing a shorter method name for use in templates

data/lib/rdoc/markdown/version.rb

@@ -2,6 +2,6 @@
 
 module Rdoc
   module Markdown
-    VERSION = "0.3.4"
+    VERSION = "0.3.5"
   end
 end

data/lib/templates/classfile.md.erb

@@ -1,20 +1,21 @@
-# <%= klass.type %> <%= klass.full_name.strip %> [](#<%= klass.aref.strip %>) [](#top)
+# <%= klass.type %> <%= klass.full_name %> [](#<%= klass.aref.strip %>) [](#top)
 <%= h klass.description %>
 <% klass.each_section do |section, constants, attributes| %>
   <% if section.title %>## <%= section.title.strip %> <% end %>
   <% if section.comment %> <%=h  section.description %><% end%>
   <% unless klass.constants.empty? %>
 ## Constants
+ | Name | Description |
+ | ---- | ----------- |
     <% klass.constants.each do |const| %>
-### <%= const.name.strip %>[](#<%= const.name.strip %>)
-<% if const.comment %> <%= h const.description %> <%else%> (Not documented) <% end %>
+ | **<%= const.name %>[](#<%= const.name %>)** | <% unless const.description.empty? %> <%= h const.description %> <%else%> Not documented <% end %> |
     <% end %>
   <% end %>
   <% unless attributes&.empty? %>
 ## Attributes
     <% attributes.each do |attr| %>
 ### <%= attr.name %>[<%= attr.rw %>] [](#<%= attr.aref.strip %>)
-<% if attr.comment %> <%= h attr.description %> <%else%> (Not documented) <% end %>
+<% if attr.comment %> <%= h(attr.description) %> <%else%> Not documented <% end %>
     <% end %>
   <% end %>
   <% klass.methods_by_type(section).each do |type, visibilities| %>
@@ -23,8 +24,8 @@
       <% next if methods.empty? %>
 ##  <%= visibility.capitalize %> <%= type.capitalize %> Methods
       <% methods.each do |method|%>
-### <%= method.name.strip %><%= method.param_seq.strip %> [](#<%= method.aref.strip %>)
-<% if method.comment %> <%= h method.description %>  <% else %> (Not documented) <%end%>
+### <%= method.name %><%= method.param_seq %> [](#<%= method.aref %>)
+<% if method.comment %> <%= h(method.description) %>  <% else %> Not documented <%end%>
       <% end %>
     <% end %>
   <% end %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rdoc-markdown
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - Stanislav (Stas) Katkov