rdoc-markdown 0.17.1 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09bb3098a38fdecae06518b91286f487fa4f547246a9ab62728037b9bc373d5b'
-  data.tar.gz: '094af12517d5e15a103e2a93c9472219b7611d4c1246999c996192ce69b5d992'
+  metadata.gz: 6769180d689a0858bfe6af579ea16ae9bbe1a4aa8ff6471bdf0e145731a3621b
+  data.tar.gz: 4e9c43e702b50a7e894f1cea99418c1c3e0d9c1070ec9b5b41fa8dc654e97df6
 SHA512:
-  metadata.gz: dcdfcc880975aed0d669ae3006f3b938b4799a3a90fe933f4972479c6edb50aa7a4fdca3c69fe617e45eb5305cf7a0f22eebef46fdc2b22206a971f97136217b
-  data.tar.gz: 62bd6ec996d342011a9b57d216ef06ba574af710eeacc69a909d280fdcb29f15851aa492f2fc729599c5c5e820ade24b9bd8cc1edf31d748896a891eebd17ca2
+  metadata.gz: 17214dddbe75a0f4496e3ab7d818b005ebfc800bb6d9c11b6c8e946f36d409054b898024f332dddb7b99025cf6704a429ad723e5d0205c34a5d264c4cf019e2f
+  data.tar.gz: 180c0790a847153dd2368c273e721a92ce6cea08119cd2d2445d5a0a88c609ae7d5a074753916a56e4f61307ad370d7f2dcc0345983de9c008bc1c6c7e0cefd4

data/CHANGELOG.md

@@ -1,8 +1,17 @@
 # Changelog
 
-
 ## Unreleased
 
+## 0.18.0
+
+- Rework heading for the document
+
+## 0.17.2
+
+- Remove spaces after headers
+- Remove legacy anchor links
+- Remove extra files that are not required (js, css and etc)
+
 ## 0.17.1
 
 - Don't include files with .tt extension

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rdoc-markdown (0.17.1)
+    rdoc-markdown (0.18.0)
       csv
       erb
       rdoc (>= 8.0)
@@ -108,7 +108,7 @@ GEM
       nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
     rainbow (3.1.1)
     rake (13.4.2)
-    rbs (4.1.0)
+    rbs (4.1.2)
       logger
       prism (>= 1.6.0)
       tsort

data/example/Bird.md

@@ -1,21 +1,20 @@
-<a id="class-bird"></a>
-# Class Bird
-The base class for all birds.
+# Class Bird<a id="class-bird"></a>
+|  |  |
+| --- | --- |
+| **Inherits** | [Object](Object.md) |
+| **Defined in** | example.rb |
 
-### Public Instance Methods
+The base class for all birds.
 
-<a id="method-i-fly"></a>
-#### `fly(direction: string, velocity: number) -> bool`
+## Public Instance Methods
+### `fly(direction: string, velocity: number) -> bool`<a id="method-i-fly"></a>
 Fly somewhere.
 
 Flying is the most critical feature of birds.
 
-##### Example
-
-```
+#### Example<a id="method-i-fly-label-Example"></a><a id="method-i-fly-example"></a>
+```ruby
 fly(:south, 70)
 ```
-
-<a id="method-i-speak"></a>
-#### `speak() { |text| ... }`
+### `speak() { |text| ... }`<a id="method-i-speak"></a>
 Produce some noise.

data/example/Duck.md

@@ -1,5 +1,10 @@
-<a id="class-duck"></a>
-# Class Duck
+# Class Duck<a id="class-duck"></a>
+|  |  |
+| --- | --- |
+| **Inherits** | [Object](Object.md) |
+| **Includes** | [Waterfowl](Waterfowl.md) |
+| **Defined in** | example.rb |
+
 A duck is a [`Waterfowl`](Waterfowl.md) [`Bird`](Bird.md).
 
 Features:
@@ -14,43 +19,27 @@ waterfowl:
 - swim
 
 ## Bird overrides
-
 ### Public Instance Methods
-
-<a id="method-i-speak"></a>
-#### `speak() { |speech| ... }`
+#### `speak() { |speech| ... }`<a id="method-i-speak"></a>
 [`Duck`](Duck.md) overrides generic implementation.
-
 ## Duck extensions
-
 ### Constants
-
-<a id="MAX_VELOCITY"></a>
-#### `MAX_VELOCITY`
+#### `MAX_VELOCITY`<a id="MAX_VELOCITY"></a>
 Not documented.
 
 ### Attributes
-
-<a id="attribute-i-domestic"></a>
-#### `domestic` [RW]
+#### `domestic` [RW]<a id="attribute-i-domestic"></a>
 True for domestic ducks.
 
-<a id="attribute-i-rubber"></a>
-#### `rubber` [R]
+#### `rubber` [R]<a id="attribute-i-rubber"></a>
 True for rubber ducks.
 
 ### Public Class Methods
-
-<a id="method-c-new"></a>
-#### `new(domestic, rubber)`
+#### `new(domestic, rubber)`<a id="method-c-new"></a>
 Creates a new duck.
-
-<a id="method-c-rubber_ducks"></a>
-#### `rubber_ducks()`
+#### `rubber_ducks()`<a id="method-c-rubber_ducks"></a>
 Returns list of all rubber ducks.
 
 ### Public Instance Methods
-
-<a id="method-i-useful-3F"></a>
-#### `useful? -> bool`
+#### `useful? -> bool`<a id="method-i-useful-3F"></a>
 Checks if this duck is a useful one.

data/example/Object.md

@@ -1,8 +1,9 @@
-<a id="class-object"></a>
-# Class Object
+# Class Object<a id="class-object"></a>
+|  |  |
+| --- | --- |
+| **Inherits** | BasicObject |
+| **Defined in** | example.rb |
 
-### Constants
-
-<a id="DEFAULT_DUCK_VELOCITY"></a>
-#### `DEFAULT_DUCK_VELOCITY`
+## Constants
+### `DEFAULT_DUCK_VELOCITY`<a id="DEFAULT_DUCK_VELOCITY"></a>
 Default velocity for a flying duck.

data/example/Waterfowl.md

@@ -1,9 +1,10 @@
-<a id="module-waterfowl"></a>
-# Module Waterfowl
-A mixin for waterfowl creatures.
+# Module Waterfowl<a id="module-waterfowl"></a>
+|  |  |
+| --- | --- |
+| **Defined in** | example.rb |
 
-### Public Instance Methods
+A mixin for waterfowl creatures.
 
-<a id="method-i-swim"></a>
-#### `swim()`
+## Public Instance Methods
+### `swim()`<a id="method-i-swim"></a>
 Swimming helper.

data/example/jekyll-seo-tag/Jekyll/SeoTag/AuthorDrop.md

@@ -1,5 +1,9 @@
-<a id="class-jekyll-seotag-authordrop"></a>
-# Class Jekyll::SeoTag::AuthorDrop
+# Class Jekyll::SeoTag::AuthorDrop<a id="class-jekyll-seotag-authordrop"></a>
+|  |  |
+| --- | --- |
+| **Inherits** | Jekyll::Drops::Drop |
+| **Defined in** | lib/jekyll-seo-tag/author_drop.rb |
+
 A drop representing the current page’s author
 
 Author name will be pulled from:
@@ -12,24 +16,16 @@ Author name will be pulled from:
 
 If the result from the name search is a string, we’ll also check for additional author metadata in `site.data.authors`
 
-### Public Class Methods
-
-<a id="method-c-new"></a>
-#### `new(page: nil, site: nil)`
+## Public Class Methods
+### `new(page: nil, site: nil)`<a id="method-c-new"></a>
 Initialize a new [`AuthorDrop`](AuthorDrop.md)
 
 page - The page hash (e.g., Page#to\_liquid) site - The Jekyll::Drops::SiteDrop
 
-### Public Instance Methods
-
-<a id="method-i-name"></a>
-#### `name()`
+## Public Instance Methods
+### `name()`<a id="method-i-name"></a>
 [`AuthorDrop#to_s`](AuthorDrop.md#method-i-to_s) should return name, allowing the author drop to safely replace `page.author`, if necessary, and remain backwards compatible
-
-<a id="method-i-to_s"></a>
-#### `to_s()`
+### `to_s()`<a id="method-i-to_s"></a>
 Alias for: [`name`](#method-i-name)
-
-<a id="method-i-twitter"></a>
-#### `twitter()`
+### `twitter()`<a id="method-i-twitter"></a>
 Not documented.

data/example/jekyll-seo-tag/Jekyll/SeoTag/Drop.md

@@ -1,108 +1,64 @@
-<a id="class-jekyll-seotag-drop"></a>
-# Class Jekyll::SeoTag::Drop
+# Class Jekyll::SeoTag::Drop<a id="class-jekyll-seotag-drop"></a>
+|  |  |
+| --- | --- |
+| **Inherits** | Jekyll::Drops::Drop |
+| **Includes** | [Jekyll::SeoTag::UrlHelper](UrlHelper.md) |
+| **Defined in** | lib/jekyll-seo-tag/drop.rb |
 
-### Constants
-
-<a id="FORMAT_STRING_METHODS"></a>
-#### `FORMAT_STRING_METHODS`
+## Constants
+### `FORMAT_STRING_METHODS`<a id="FORMAT_STRING_METHODS"></a>
 Not documented.
 
-<a id="HOMEPAGE_OR_ABOUT_REGEX"></a>
-#### `HOMEPAGE_OR_ABOUT_REGEX`
+### `HOMEPAGE_OR_ABOUT_REGEX`<a id="HOMEPAGE_OR_ABOUT_REGEX"></a>
 Not documented.
 
-<a id="TITLE_SEPARATOR"></a>
-#### `TITLE_SEPARATOR`
+### `TITLE_SEPARATOR`<a id="TITLE_SEPARATOR"></a>
 Not documented.
 
-### Public Class Methods
-
-<a id="method-c-new"></a>
-#### `new(text, context)`
+## Public Class Methods
+### `new(text, context)`<a id="method-c-new"></a>
 Not documented.
 
-### Public Instance Methods
-
-<a id="method-i-author"></a>
-#### `author()`
+## Public Instance Methods
+### `author()`<a id="method-i-author"></a>
 A drop representing the page author
-
-<a id="method-i-canonical_url"></a>
-#### `canonical_url()`
+### `canonical_url()`<a id="method-i-canonical_url"></a>
 Not documented.
-
-<a id="method-i-date_modified"></a>
-#### `date_modified()`
+### `date_modified()`<a id="method-i-date_modified"></a>
 Not documented.
-
-<a id="method-i-date_published"></a>
-#### `date_published()`
+### `date_published()`<a id="method-i-date_published"></a>
 Not documented.
-
-<a id="method-i-description"></a>
-#### `description()`
+### `description()`<a id="method-i-description"></a>
 Not documented.
-
-<a id="method-i-image"></a>
-#### `image()`
+### `image()`<a id="method-i-image"></a>
 Returns a [`Drop`](Drop.md) representing the page’s image Returns nil if the image has no path, to preserve backwards compatability
-
-<a id="method-i-json_ld"></a>
-#### `json_ld()`
+### `json_ld()`<a id="method-i-json_ld"></a>
 A drop representing the JSON-LD output
-
-<a id="method-i-links"></a>
-#### `links()`
+### `links()`<a id="method-i-links"></a>
 Not documented.
-
-<a id="method-i-logo"></a>
-#### `logo()`
+### `logo()`<a id="method-i-logo"></a>
 Not documented.
-
-<a id="method-i-name"></a>
-#### `name()`
+### `name()`<a id="method-i-name"></a>
 rubocop:enable Metrics/CyclomaticComplexity
-
-<a id="method-i-page_lang"></a>
-#### `page_lang()`
+### `page_lang()`<a id="method-i-page_lang"></a>
 Not documented.
-
-<a id="method-i-page_locale"></a>
-#### `page_locale()`
+### `page_locale()`<a id="method-i-page_locale"></a>
 Not documented.
-
-<a id="method-i-page_title"></a>
-#### `page_title()`
+### `page_title()`<a id="method-i-page_title"></a>
 Page title without site title or description appended
-
-<a id="method-i-site_description"></a>
-#### `site_description()`
+### `site_description()`<a id="method-i-site_description"></a>
 Not documented.
-
-<a id="method-i-site_tagline"></a>
-#### `site_tagline()`
+### `site_tagline()`<a id="method-i-site_tagline"></a>
 Not documented.
-
-<a id="method-i-site_tagline_or_description"></a>
-#### `site_tagline_or_description()`
+### `site_tagline_or_description()`<a id="method-i-site_tagline_or_description"></a>
 Not documented.
-
-<a id="method-i-site_title"></a>
-#### `site_title()`
+### `site_title()`<a id="method-i-site_title"></a>
 Not documented.
-
-<a id="method-i-title"></a>
-#### `title()`
+### `title()`<a id="method-i-title"></a>
 Page title with site title or description appended rubocop:disable Metrics/CyclomaticComplexity
-
-<a id="method-i-title-3F"></a>
-#### `title?()`
+### `title?()`<a id="method-i-title-3F"></a>
 Should the ‘\<title\>` tag be generated for this page?
-
-<a id="method-i-type"></a>
-#### `type()`
+### `type()`<a id="method-i-type"></a>
 Not documented.
-
-<a id="method-i-version"></a>
-#### `version()`
+### `version()`<a id="method-i-version"></a>
 Not documented.

data/example/jekyll-seo-tag/Jekyll/SeoTag/Filters.md

@@ -1,8 +1,10 @@
-<a id="class-jekyll-seotag-filters"></a>
-# Class Jekyll::SeoTag::Filters
+# Class Jekyll::SeoTag::Filters<a id="class-jekyll-seotag-filters"></a>
+|  |  |
+| --- | --- |
+| **Inherits** | Object |
+| **Includes** | Jekyll::Filters, Liquid::StandardFilters |
+| **Defined in** | lib/jekyll-seo-tag/filters.rb |
 
-### Public Class Methods
-
-<a id="method-c-new"></a>
-#### `new(context)`
+## Public Class Methods
+### `new(context)`<a id="method-c-new"></a>
 Not documented.

data/example/jekyll-seo-tag/Jekyll/SeoTag/ImageDrop.md

@@ -1,5 +1,10 @@
-<a id="class-jekyll-seotag-imagedrop"></a>
-# Class Jekyll::SeoTag::ImageDrop
+# Class Jekyll::SeoTag::ImageDrop<a id="class-jekyll-seotag-imagedrop"></a>
+|  |  |
+| --- | --- |
+| **Inherits** | Jekyll::Drops::Drop |
+| **Includes** | [Jekyll::SeoTag::UrlHelper](UrlHelper.md) |
+| **Defined in** | lib/jekyll-seo-tag/image_drop.rb |
+
 A drop representing the page image The image path will be pulled from:
 
 1. The `image` key if it’s a string
@@ -10,20 +15,14 @@ A drop representing the page image The image path will be pulled from:
 
 4. The `image.twitter` key
 
-### Public Class Methods
-
-<a id="method-c-new"></a>
-#### `new(page: nil, context: nil)`
+## Public Class Methods
+### `new(page: nil, context: nil)`<a id="method-c-new"></a>
 Initialize a new [`ImageDrop`](ImageDrop.md)
 
 page - The page hash (e.g., Page#to\_liquid) context - the Liquid::Context
 
-### Public Instance Methods
-
-<a id="method-i-path"></a>
-#### `path()`
+## Public Instance Methods
+### `path()`<a id="method-i-path"></a>
 Called path for backwards compatability, this is really the escaped, absolute URL representing the page’s image Returns nil if no image path can be determined
-
-<a id="method-i-to_s"></a>
-#### `to_s()`
+### `to_s()`<a id="method-i-to_s"></a>
 Alias for: [`path`](#method-i-path)

data/example/jekyll-seo-tag/Jekyll/SeoTag/JSONLD.md

@@ -1,15 +1,14 @@
-<a id="module-jekyll-seotag-jsonld"></a>
-# Module Jekyll::SeoTag::JSONLD
-This module is deprecated, but is included in the Gem to avoid a breaking change and should be removed at the next major version bump
+# Module Jekyll::SeoTag::JSONLD<a id="module-jekyll-seotag-jsonld"></a>
+|  |  |
+| --- | --- |
+| **Defined in** | lib/jekyll-seo-tag/json_ld.rb |
 
-### Constants
+This module is deprecated, but is included in the Gem to avoid a breaking change and should be removed at the next major version bump
 
-<a id="METHODS_KEYS"></a>
-#### `METHODS_KEYS`
+## Constants
+### `METHODS_KEYS`<a id="METHODS_KEYS"></a>
 Not documented.
 
-### Public Instance Methods
-
-<a id="method-i-json_ld"></a>
-#### `json_ld()`
+## Public Instance Methods
+### `json_ld()`<a id="method-i-json_ld"></a>
 Self should be a [`Jekyll::SeoTag::Drop`](Drop.md) instance (when extending the module)

data/example/jekyll-seo-tag/Jekyll/SeoTag/JSONLDDrop.md

@@ -1,34 +1,23 @@
-<a id="class-jekyll-seotag-jsonlddrop"></a>
-# Class Jekyll::SeoTag::JSONLDDrop
-
-### Public Class Methods
-
-<a id="method-c-new"></a>
-#### `new(page_drop)`
+# Class Jekyll::SeoTag::JSONLDDrop<a id="class-jekyll-seotag-jsonlddrop"></a>
+|  |  |
+| --- | --- |
+| **Inherits** | Jekyll::Drops::Drop |
+| **Defined in** | lib/jekyll-seo-tag/json_ld_drop.rb |
+
+## Public Class Methods
+### `new(page_drop)`<a id="method-c-new"></a>
 page\_drop should be an instance of [`Jekyll::SeoTag::Drop`](Drop.md)
 
-### Public Instance Methods
-
-<a id="method-i-author"></a>
-#### `author()`
+## Public Instance Methods
+### `author()`<a id="method-i-author"></a>
 Not documented.
-
-<a id="method-i-fallback_data"></a>
-#### `fallback_data()`
+### `fallback_data()`<a id="method-i-fallback_data"></a>
 Not documented.
-
-<a id="method-i-image"></a>
-#### `image()`
+### `image()`<a id="method-i-image"></a>
 Not documented.
-
-<a id="method-i-mainEntityOfPage"></a>
-#### `mainEntityOfPage()`
+### `mainEntityOfPage()`<a id="method-i-mainEntityOfPage"></a>
 Alias for: [`main_entity`](#method-i-main_entity)
-
-<a id="method-i-publisher"></a>
-#### `publisher()`
+### `publisher()`<a id="method-i-publisher"></a>
 Not documented.
-
-<a id="method-i-to_json"></a>
-#### `to_json(state = nil)`
+### `to_json(state = nil)`<a id="method-i-to_json"></a>
 Returns a JSON-encoded object containing the JSON-LD data. Keys are sorted.

data/example/jekyll-seo-tag/Jekyll/SeoTag/UrlHelper.md

@@ -1,4 +1,7 @@
-<a id="module-jekyll-seotag-urlhelper"></a>
-# Module Jekyll::SeoTag::UrlHelper
+# Module Jekyll::SeoTag::UrlHelper<a id="module-jekyll-seotag-urlhelper"></a>
+|  |  |
+| --- | --- |
+| **Defined in** | lib/jekyll-seo-tag/url_helper.rb |
+
 Mixin to share common URL-related methods between class
 

data/example/jekyll-seo-tag/Jekyll/SeoTag.md

@@ -1,10 +1,11 @@
-<a id="class-jekyll-seotag"></a>
-# Class Jekyll::SeoTag
-
-### Constants
-
-<a id="MINIFY_REGEX"></a>
-#### `MINIFY_REGEX`
+# Class Jekyll::SeoTag<a id="class-jekyll-seotag"></a>
+|  |  |
+| --- | --- |
+| **Inherits** | [Liquid::Tag](../Liquid/Tag.md) |
+| **Defined in** | lib/jekyll-seo-tag.rb, lib/jekyll-seo-tag/author_drop.rb, lib/jekyll-seo-tag/drop.rb, lib/jekyll-seo-tag/filters.rb, lib/jekyll-seo-tag/image_drop.rb, lib/jekyll-seo-tag/json_ld.rb, lib/jekyll-seo-tag/json_ld_drop.rb, lib/jekyll-seo-tag/url_helper.rb, lib/jekyll-seo-tag/version.rb |
+
+## Constants
+### `MINIFY_REGEX`<a id="MINIFY_REGEX"></a>
 Matches all whitespace that follows either
 
 ```
@@ -21,28 +22,19 @@ so that we do not interfere with the HTML comment at the
 very begining
 ```
 
-<a id="VERSION"></a>
-#### `VERSION`
+### `VERSION`<a id="VERSION"></a>
 Not documented.
 
-### Attributes
-
-<a id="attribute-i-context"></a>
-#### `context` [RW]
+## Attributes
+### `context` [RW]<a id="attribute-i-context"></a>
 Not documented.
 
-### Public Class Methods
-
-<a id="method-c-new"></a>
-#### `new(_tag_name, text, _tokens)`
+## Public Class Methods
+### `new(_tag_name, text, _tokens)`<a id="method-c-new"></a>
 Not documented.
-
-<a id="method-c-template"></a>
-#### `template()`
+### `template()`<a id="method-c-template"></a>
 Not documented.
 
-### Public Instance Methods
-
-<a id="method-i-render"></a>
-#### `render(context)`
+## Public Instance Methods
+### `render(context)`<a id="method-i-render"></a>
 Not documented.

data/example/jekyll-seo-tag/Jekyll.md

@@ -1,3 +1,5 @@
-<a id="module-jekyll"></a>
-# Module Jekyll
+# Module Jekyll<a id="module-jekyll"></a>
+|  |  |
+| --- | --- |
+| **Defined in** | lib/jekyll-seo-tag.rb, lib/jekyll-seo-tag/author_drop.rb, lib/jekyll-seo-tag/drop.rb, lib/jekyll-seo-tag/filters.rb, lib/jekyll-seo-tag/image_drop.rb, lib/jekyll-seo-tag/json_ld.rb, lib/jekyll-seo-tag/json_ld_drop.rb, lib/jekyll-seo-tag/url_helper.rb, lib/jekyll-seo-tag/version.rb |
 

data/example/jekyll-seo-tag/Liquid/Tag.md

@@ -1,3 +1,6 @@
-<a id="class-liquid-tag"></a>
-# Class Liquid::Tag
+# Class Liquid::Tag<a id="class-liquid-tag"></a>
+|  |  |
+| --- | --- |
+| **Inherits** | Object |
+| **Defined in** | lib/jekyll-seo-tag/version.rb |
 

data/example/jekyll-seo-tag/Liquid.md

@@ -1,4 +1,7 @@
-<a id="module-liquid"></a>
-# Module Liquid
+# Module Liquid<a id="module-liquid"></a>
+|  |  |
+| --- | --- |
+| **Defined in** | lib/jekyll-seo-tag/version.rb |
+
 Prevent bundler errors
 

data/lib/rdoc/generator/markdown.rb

@@ -224,7 +224,7 @@ class RDoc::Generator::Markdown
       out_file = Pathname.new("#{output_dir}/#{page_output_path(page)}")
       out_file.dirname.mkpath
 
-      next FileUtils.cp(File.expand_path(page.absolute_name, @source_dir), out_file) if page.relative_name.end_with?(".md", ".markdown")
+      next FileUtils.cp(File.expand_path(page.absolute_name, @source_dir), out_file) if page.relative_name.match?(/\.(?:md|markdown)\z/i)
 
       content = markdownify(render_description(page))
       File.write(out_file, finalize_markdown(
@@ -250,7 +250,7 @@ class RDoc::Generator::Markdown
   # @return [String] Relative Markdown path.
   def page_output_path(page)
     source_path = normalize_input_path_for_output(page.relative_name)
-    return source_path if page.relative_name.match?(/\.(?:md|markdown)\z/)
+    return source_path if page.relative_name.match?(/\.(?:md|markdown)\z/i)
 
     dirname = File.dirname(source_path)
     basename = "#{File.basename(source_path).tr(".", "_")}.md"
@@ -306,6 +306,13 @@ class RDoc::Generator::Markdown
     # - raise - Raise an error to let you know
 
     fragment = Nokogiri::HTML.fragment(input)
+    fragment.css("span.legacy-anchor[id]").select do |span|
+      span.next_element&.name == "h1" && span["id"].match?(/\A(?:class|module)-/)
+    end.each(&:remove)
+    fragment.css("span.legacy-anchor[id]").each do |span|
+      heading = span.next_element
+      heading.add_child(span) if heading&.name&.match?(/\Ah[1-6]\z/)
+    end
 
     fragment.css("pre").each do |pre|
       language = pre["class"].to_s[/\A(?!highlight\z)[A-Za-z][A-Za-z0-9_+-]*\z/]
@@ -357,9 +364,7 @@ class RDoc::Generator::Markdown
       unknown_tags: @markdown_unknown_tags
     ).dup
     anchor_aliases.each do |token, id|
-      anchor = %(<a id="#{id}"></a>)
-      md.gsub!("#{token}\n\n#", "#{anchor}\n#")
-      md.gsub!(token, anchor)
+      md.gsub!(token, %(<a id="#{id}"></a>))
     end
 
     normalize_definition_list_code_blocks(md).rstrip
@@ -582,10 +587,11 @@ class RDoc::Generator::Markdown
   #
   # @param method [RDoc::AnyMethod] Method object to render.
   # @param current_class [RDoc::Context] Class or module currently being rendered.
+  # @param heading_level_offset [Integer] Heading levels to add while rendering.
   #
   # @return [String] Rendered method description.
-  def method_description(method, current_class:)
-    text = describe(method, heading_level_offset: 4)
+  def method_description(method, current_class:, heading_level_offset:)
+    text = describe(method, heading_level_offset: heading_level_offset)
     return text unless text.empty?
 
     aliased_method = method.is_alias_for
@@ -607,6 +613,7 @@ class RDoc::Generator::Markdown
     output = content.lines.map(&:rstrip).join("\n")
     output = normalize_internal_links(output, current_output_path: current_output_path)
     output = output.sub(/\n{3,}/, "\n\n")
+    output = output.gsub(/^(#+ .+)\n\n/, "\\1\n")
     "#{output}\n"
   end
 
@@ -711,7 +718,7 @@ class RDoc::Generator::Markdown
   # @return [String, nil] Resolved output path, or nil when unresolved.
   def resolve_output_path(path, current_dir)
     candidates = [path, path.delete_prefix("#{@root_path_segment}/")]
-    candidates += candidates.map { |candidate| candidate.sub(/_(md|markdown)\.md\z/, '.\1') }
+    candidates += candidates.map { |candidate| candidate.sub(/_(md|markdown)\.md\z/i, '.\1') }
 
     candidates.each do |candidate|
       return candidate if @known_output_paths.include?(candidate)
@@ -761,7 +768,7 @@ class RDoc::Generator::Markdown
     end.sort
     @class_output_paths = @classes.to_h { |klass| [klass.full_name, output_path_for(klass)] }
     @pages = @store.all_files.select(&:text?).select(&:display?)
-      .reject { |page| page.relative_name.end_with?(".tt") }
+      .select { |page| page.relative_name.match?(/\.(?:md|markdown|rdoc)\z/i) }
       .sort_by(&:base_name)
     @markdown_output_object_ids = (@classes + @pages).map(&:object_id)
     @known_output_paths = @class_output_paths.values

data/lib/rdoc/markdown/version.rb

@@ -5,6 +5,6 @@ module Rdoc
   # @private
   module Markdown
     # @private
-    VERSION = "0.17.1"
+    VERSION = "0.18.0"
   end
 end

data/lib/templates/classfile.md.erb

@@ -25,30 +25,33 @@
 <%- end -%>
 <% klass.each_section do |section, constants, attributes| -%>
 <%- section_title = section.title.to_s.strip -%>
+<%- section_heading_level = section_title.empty? ? 1 : 2 -%>
+<%- group_heading_level = section_heading_level + 1 -%>
+<%- member_heading_level = group_heading_level + 1 -%>
 <%- unless section_title.empty? -%>
-## <%= section_title %>
+<%= "#" * section_heading_level %> <%= section_title %>
 <%- end -%>
-<%- section_description = section_description(section, heading_level_offset: 2) -%>
+<%- section_description = section_description(section, heading_level_offset: section_heading_level) -%>
 <%- unless section_description.empty? -%>
 
 <%= section_description %>
 <%- end -%>
 <%- unless constants.empty? -%>
 
-### Constants
+<%= "#" * group_heading_level %> Constants
 <% constants.sort_by(&:name).each do |const| -%>
 
-#### `<%= const.name %>`<%= anchor(const.name) %>
-<%= describe(const, fallback: "Not documented.", heading_level_offset: 4) %>
+<%= "#" * member_heading_level %> `<%= const.name %>`<%= anchor(const.name) %>
+<%= describe(const, fallback: "Not documented.", heading_level_offset: member_heading_level) %>
 <% end -%>
 <%- end -%>
 <%- unless attributes.empty? -%>
 
-### Attributes
+<%= "#" * group_heading_level %> Attributes
 <% attributes.sort_by(&:name).each do |attr| -%>
 
-#### `<%= attr.name %>` [<%= attr.rw %>]<%= anchor(attr.aref.strip) %>
-<%= describe(attr, fallback: "Not documented.", heading_level_offset: 4) %>
+<%= "#" * member_heading_level %> `<%= attr.name %>` [<%= attr.rw %>]<%= anchor(attr.aref.strip) %>
+<%= describe(attr, fallback: "Not documented.", heading_level_offset: member_heading_level) %>
 <% end -%>
 <%- end -%>
 <% klass.methods_by_type(section).each do |type, visibilities| -%>
@@ -56,10 +59,10 @@
 <% methods = methods.select(&:display?) -%>
 <% next if methods.empty? -%>
 
-### <%= visibility.capitalize %> <%= type.capitalize %> Methods
+<%= "#" * group_heading_level %> <%= visibility.capitalize %> <%= type.capitalize %> Methods
 <% methods.each do |method| -%>
-#### `<%= method.name %><%= method_signature(method) %>`<%= anchor(method.aref) %>
-<%= method_description(method, current_class: klass) %>
+<%= "#" * member_heading_level %> `<%= method.name %><%= method_signature(method) %>`<%= anchor(method.aref) %>
+<%= method_description(method, current_class: klass, heading_level_offset: member_heading_level) %>
 <% end -%>
 <% end -%>
 <% end -%>

metadata

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