rdoc-markdown 0.21.0 → 0.21.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b215eca69feb6c88372f2a84436dff0c42712e0f3deb7086c91e9ee1f0e8cd3
-  data.tar.gz: 3ce6ccaeecfd189da39207c07e6f6733c5f183589eb90a3474ea3316b80c0445
+  metadata.gz: feb14b11dc71c71a4e9e0af4a71f6d074706120984b7b5c6c890c126e8894e23
+  data.tar.gz: ea5b339442fe650abae65db6f5ce051a959c361056b651cde5fb7ae2b1daf778
 SHA512:
-  metadata.gz: 5cc5f170e0eae86a2f5ba510db36fb9f1bf5b1eca91d7b3a31fb95f1a0b2188ff8d1b48892fb98c65bfa2b7b46e9d80cbe5c852595e540f214204d0a9d3c936f
-  data.tar.gz: 3df4e291559a57ca7cf727e1e59b60ae8c292cd6defadb7a0c8cef91e1bd56f504e8ab9072d75a9978658efd19b8a0613b7884352ce57cd7cd5d67143762f322
+  metadata.gz: c0a5a47ff262d233b3bebb8f2016f1f31f3a0ce106ce3d25e68f46251bed353cc5df1a26e4534a9e92159e9ee458965d0864b91f94f4c48100f4f54d012824ce
+  data.tar.gz: a95167a0eed14716ce4014cd6330c73cb546fa45a553f747e883b64f7614c54638656ce6ce76a95bc6e64ae9f9f8051ceabcfd02c30c060e8d0aa1a94aa8ac85

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## Unreleased
 
+## 0.21.2
+
+- Distinguish instance methods (`Class#method`) from class methods (`Class.method`) in search-index names, without changing their document paths or anchors.
+
+## 0.21.1
+
+- Preserve hash-prefixed comments and literal Markdown headings in code examples when offsetting documentation headings.
+
+## 0.21.0
 - Keep generated method and section headings readable after raw HTML descriptions.
 - Validate search-index targets and same-document links against parsed Markdown headings and anchors, including alias targets.
 - Leave alias targets unlinked when RDoc has removed the canonical method from the generated documentation.

data/README.md

@@ -1,15 +1,8 @@
 # RDoc-Markdown
 RDoc plugin to generate markdown documentation and search index file (CSV).
 
-> [!CAUTION]
-> This gem relies on multiple hacks to generate "plausible" markdown documentation. This is **NOT PRODUCTION READY** — use at your own risk.
->
-> RDoc maintainers are actively working on markdown support, things will improve with time...
-
 ## Motivation
-Markdown has become the de facto documentation standard. We can render markdown files on any device, possibly on a thermometer with a screen. And everyone knows markdown...
-
-It's a pity that RDoc can't output a proper markdown file. Somebody has to try to build it.
+Markdown has become the de facto documentation standard. Rdoc should be able to output it too.
 
 ## Installation
 

data/lib/rdoc/generator/markdown/conversion.rb

@@ -9,15 +9,13 @@ class RDoc::Generator::Markdown::Conversion
   #
   # @return [String] Markdown with normalized links and no trailing whitespace.
   def self.markdownify(input, heading_level_offset: 0)
-    fragment = normalized_html_fragment(input)
+    fragment = normalized_html_fragment(input, heading_level_offset)
     anchor_aliases = tokenize_legacy_anchors(fragment.css("span.legacy-anchor[id]"))
     document = fragment.document
     fragment.css("a").each { |link| normalize_link(link, document) }
     markdown = ReverseMarkdown.convert(fragment, github_flavored: true).dup
     markdown.gsub!(Regexp.union(anchor_aliases.keys), anchor_aliases)
-    normalize_definition_lists(markdown).rstrip.gsub(/^(#+)(\s)/) do
-      "#{"#" * [Regexp.last_match(1).length + heading_level_offset, 6].min}#{Regexp.last_match(2)}"
-    end
+    normalize_definition_lists(markdown).rstrip
   end
 
   class << self
@@ -26,9 +24,10 @@ class RDoc::Generator::Markdown::Conversion
     # Normalizes HTML constructs that reverse_markdown cannot preserve directly.
     #
     # @param input [String] RDoc HTML fragment.
+    # @param heading_level_offset [Integer] Heading levels to add to actual HTML headings.
     #
     # @return [Nokogiri::HTML4::DocumentFragment] Normalized fragment.
-    def normalized_html_fragment(input)
+    def normalized_html_fragment(input, heading_level_offset)
       fragment = Nokogiri::HTML.fragment(input)
       context_anchors, content_anchors = fragment.css("span.legacy-anchor[id]").partition do |span|
         context_anchor?(span)
@@ -41,7 +40,7 @@ class RDoc::Generator::Markdown::Conversion
       normalize_pre_blocks(fragment)
       document = fragment.document
       fragment.css("h1, h2, h3, h4, h5, h6").each do |heading|
-        normalize_heading_link(heading, document)
+        normalize_heading(heading, document, heading_level_offset)
       end
       fragment
     end
@@ -68,13 +67,15 @@ class RDoc::Generator::Markdown::Conversion
       end
     end
 
-    # Normalizes one heading's leading fragment link.
+    # Normalizes one heading's level and leading fragment link.
     #
     # @param heading [Nokogiri::XML::Element] Heading element.
     # @param document [Nokogiri::HTML4::Document] Owning document.
+    # @param heading_level_offset [Integer] Heading levels to add, capped at six.
     #
     # @return [void]
-    def normalize_heading_link(heading, document)
+    def normalize_heading(heading, document, heading_level_offset)
+      heading.name = "h#{[Integer(heading.name.delete_prefix("h")) + heading_level_offset, 6].min}"
       link = heading.xpath("./a[starts-with(@href, '#') and string-length(@href) > 1]").find do |anchor|
         leading_heading_link?(anchor)
       end

data/lib/rdoc/generator/markdown/index.rb

@@ -34,7 +34,8 @@ module RDoc::Generator::Markdown::Index
     csv << [class_name, klass.type.capitalize, output_path]
 
     klass.method_list.select(&:display?).each do |method|
-      csv << ["#{class_name}.#{method.name}", "Method", "#{output_path}##{method.aref}"]
+      separator = method.singleton ? "." : "#"
+      csv << ["#{class_name}#{separator}#{method.name}", "Method", "#{output_path}##{method.aref}"]
     end
     klass.constants.select(&:display?).sort.each do |const|
       name = const.name

data/lib/rdoc/markdown/version.rb

@@ -5,6 +5,6 @@ module Rdoc
   # @private
   module Markdown
     # @private
-    VERSION = "0.21.0"
+    VERSION = "0.21.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rdoc-markdown
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.21.2
 platform: ruby
 authors:
 - Stanislav (Stas) Katkov
@@ -208,7 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.19
+rubygems_version: 4.0.20
 specification_version: 4
 summary: RDoc plugin to generate markdown documentation
 test_files: []