rdoc-markdown 0.18.0 → 0.19.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +5 -0
  3. data/README.md +19 -82
  4. data/lib/markdown.rb +0 -4
  5. data/lib/rdoc/discover.rb +1 -7
  6. data/lib/rdoc/generator/markdown/conversion.rb +196 -0
  7. data/lib/rdoc/generator/markdown/crossref.rb +13 -5
  8. data/lib/rdoc/generator/markdown/descriptions.rb +163 -0
  9. data/lib/rdoc/generator/markdown/index.rb +47 -0
  10. data/lib/rdoc/generator/markdown/paths.rb +118 -0
  11. data/lib/rdoc/generator/markdown/selection.rb +39 -0
  12. data/lib/rdoc/generator/markdown/signatures.rb +174 -0
  13. data/lib/rdoc/generator/markdown.rb +80 -681
  14. data/lib/rdoc/markdown/version.rb +1 -1
  15. metadata +19 -43
  16. data/.editorconfig +0 -13
  17. data/.erb_lint.yml +0 -36
  18. data/.erb_linters/no_embedded_assets.rb +0 -29
  19. data/.erb_linters/non_raw_html.rb +0 -29
  20. data/.standard.yml +0 -3
  21. data/.yard-lint.yml +0 -290
  22. data/AGENTS.md +0 -50
  23. data/CODE_OF_CONDUCT.md +0 -84
  24. data/Gemfile +0 -13
  25. data/Gemfile.lock +0 -202
  26. data/Rakefile +0 -296
  27. data/example/Bird.md +0 -20
  28. data/example/Duck.md +0 -45
  29. data/example/Object.md +0 -9
  30. data/example/Waterfowl.md +0 -10
  31. data/example/index.csv +0 -16
  32. data/example/jekyll-seo-tag/Jekyll/SeoTag/AuthorDrop.md +0 -31
  33. data/example/jekyll-seo-tag/Jekyll/SeoTag/Drop.md +0 -64
  34. data/example/jekyll-seo-tag/Jekyll/SeoTag/Filters.md +0 -10
  35. data/example/jekyll-seo-tag/Jekyll/SeoTag/ImageDrop.md +0 -28
  36. data/example/jekyll-seo-tag/Jekyll/SeoTag/JSONLD.md +0 -14
  37. data/example/jekyll-seo-tag/Jekyll/SeoTag/JSONLDDrop.md +0 -23
  38. data/example/jekyll-seo-tag/Jekyll/SeoTag/UrlHelper.md +0 -7
  39. data/example/jekyll-seo-tag/Jekyll/SeoTag.md +0 -40
  40. data/example/jekyll-seo-tag/Jekyll.md +0 -5
  41. data/example/jekyll-seo-tag/Liquid/Tag.md +0 -6
  42. data/example/jekyll-seo-tag/Liquid.md +0 -7
  43. data/example/jekyll-seo-tag/index.csv +0 -60
  44. data/mutant.yml +0 -15
  45. data/rdoc-markdown.gemspec +0 -46
@@ -1,10 +0,0 @@
1
- # Class Jekyll::SeoTag::Filters<a id="class-jekyll-seotag-filters"></a>
2
- | | |
3
- | --- | --- |
4
- | **Inherits** | Object |
5
- | **Includes** | Jekyll::Filters, Liquid::StandardFilters |
6
- | **Defined in** | lib/jekyll-seo-tag/filters.rb |
7
-
8
- ## Public Class Methods
9
- ### `new(context)`<a id="method-c-new"></a>
10
- Not documented.
@@ -1,28 +0,0 @@
1
- # Class Jekyll::SeoTag::ImageDrop<a id="class-jekyll-seotag-imagedrop"></a>
2
- | | |
3
- | --- | --- |
4
- | **Inherits** | Jekyll::Drops::Drop |
5
- | **Includes** | [Jekyll::SeoTag::UrlHelper](UrlHelper.md) |
6
- | **Defined in** | lib/jekyll-seo-tag/image_drop.rb |
7
-
8
- A drop representing the page image The image path will be pulled from:
9
-
10
- 1. The `image` key if it’s a string
11
-
12
- 2. The `image.path` key if it’s a hash
13
-
14
- 3. The `image.facebook` key
15
-
16
- 4. The `image.twitter` key
17
-
18
- ## Public Class Methods
19
- ### `new(page: nil, context: nil)`<a id="method-c-new"></a>
20
- Initialize a new [`ImageDrop`](ImageDrop.md)
21
-
22
- page - The page hash (e.g., Page#to\_liquid) context - the Liquid::Context
23
-
24
- ## Public Instance Methods
25
- ### `path()`<a id="method-i-path"></a>
26
- 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
27
- ### `to_s()`<a id="method-i-to_s"></a>
28
- Alias for: [`path`](#method-i-path)
@@ -1,14 +0,0 @@
1
- # Module Jekyll::SeoTag::JSONLD<a id="module-jekyll-seotag-jsonld"></a>
2
- | | |
3
- | --- | --- |
4
- | **Defined in** | lib/jekyll-seo-tag/json_ld.rb |
5
-
6
- 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
7
-
8
- ## Constants
9
- ### `METHODS_KEYS`<a id="METHODS_KEYS"></a>
10
- Not documented.
11
-
12
- ## Public Instance Methods
13
- ### `json_ld()`<a id="method-i-json_ld"></a>
14
- Self should be a [`Jekyll::SeoTag::Drop`](Drop.md) instance (when extending the module)
@@ -1,23 +0,0 @@
1
- # Class Jekyll::SeoTag::JSONLDDrop<a id="class-jekyll-seotag-jsonlddrop"></a>
2
- | | |
3
- | --- | --- |
4
- | **Inherits** | Jekyll::Drops::Drop |
5
- | **Defined in** | lib/jekyll-seo-tag/json_ld_drop.rb |
6
-
7
- ## Public Class Methods
8
- ### `new(page_drop)`<a id="method-c-new"></a>
9
- page\_drop should be an instance of [`Jekyll::SeoTag::Drop`](Drop.md)
10
-
11
- ## Public Instance Methods
12
- ### `author()`<a id="method-i-author"></a>
13
- Not documented.
14
- ### `fallback_data()`<a id="method-i-fallback_data"></a>
15
- Not documented.
16
- ### `image()`<a id="method-i-image"></a>
17
- Not documented.
18
- ### `mainEntityOfPage()`<a id="method-i-mainEntityOfPage"></a>
19
- Alias for: [`main_entity`](#method-i-main_entity)
20
- ### `publisher()`<a id="method-i-publisher"></a>
21
- Not documented.
22
- ### `to_json(state = nil)`<a id="method-i-to_json"></a>
23
- Returns a JSON-encoded object containing the JSON-LD data. Keys are sorted.
@@ -1,7 +0,0 @@
1
- # Module Jekyll::SeoTag::UrlHelper<a id="module-jekyll-seotag-urlhelper"></a>
2
- | | |
3
- | --- | --- |
4
- | **Defined in** | lib/jekyll-seo-tag/url_helper.rb |
5
-
6
- Mixin to share common URL-related methods between class
7
-
@@ -1,40 +0,0 @@
1
- # Class Jekyll::SeoTag<a id="class-jekyll-seotag"></a>
2
- | | |
3
- | --- | --- |
4
- | **Inherits** | [Liquid::Tag](../Liquid/Tag.md) |
5
- | **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 |
6
-
7
- ## Constants
8
- ### `MINIFY_REGEX`<a id="MINIFY_REGEX"></a>
9
- Matches all whitespace that follows either
10
-
11
- ```
12
- 1. A '}', which closes a Liquid tag
13
- 2. A '{', which opens a JSON block
14
- 3. A '>' followed by a newline, which closes an XML tag or
15
- 4. A ',' followed by a newline, which ends a JSON line
16
- ```
17
-
18
- We will strip all of this whitespace to minify the template We will not strip any whitespace if the next character is a ‘-’
19
-
20
- ```
21
- so that we do not interfere with the HTML comment at the
22
- very begining
23
- ```
24
-
25
- ### `VERSION`<a id="VERSION"></a>
26
- Not documented.
27
-
28
- ## Attributes
29
- ### `context` [RW]<a id="attribute-i-context"></a>
30
- Not documented.
31
-
32
- ## Public Class Methods
33
- ### `new(_tag_name, text, _tokens)`<a id="method-c-new"></a>
34
- Not documented.
35
- ### `template()`<a id="method-c-template"></a>
36
- Not documented.
37
-
38
- ## Public Instance Methods
39
- ### `render(context)`<a id="method-i-render"></a>
40
- Not documented.
@@ -1,5 +0,0 @@
1
- # Module Jekyll<a id="module-jekyll"></a>
2
- | | |
3
- | --- | --- |
4
- | **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 |
5
-
@@ -1,6 +0,0 @@
1
- # Class Liquid::Tag<a id="class-liquid-tag"></a>
2
- | | |
3
- | --- | --- |
4
- | **Inherits** | Object |
5
- | **Defined in** | lib/jekyll-seo-tag/version.rb |
6
-
@@ -1,7 +0,0 @@
1
- # Module Liquid<a id="module-liquid"></a>
2
- | | |
3
- | --- | --- |
4
- | **Defined in** | lib/jekyll-seo-tag/version.rb |
5
-
6
- Prevent bundler errors
7
-
@@ -1,60 +0,0 @@
1
- name,type,path
2
- Jekyll,Module,Jekyll.md
3
- Jekyll::SeoTag,Class,Jekyll/SeoTag.md
4
- Jekyll::SeoTag.new,Method,Jekyll/SeoTag.md#method-c-new
5
- Jekyll::SeoTag.render,Method,Jekyll/SeoTag.md#method-i-render
6
- Jekyll::SeoTag.template,Method,Jekyll/SeoTag.md#method-c-template
7
- Jekyll::SeoTag.MINIFY_REGEX,Constant,Jekyll/SeoTag.md#MINIFY_REGEX
8
- Jekyll::SeoTag.VERSION,Constant,Jekyll/SeoTag.md#VERSION
9
- Jekyll::SeoTag.context,Attribute,Jekyll/SeoTag.md#attribute-i-context
10
- Jekyll::SeoTag::AuthorDrop,Class,Jekyll/SeoTag/AuthorDrop.md
11
- Jekyll::SeoTag::AuthorDrop.new,Method,Jekyll/SeoTag/AuthorDrop.md#method-c-new
12
- Jekyll::SeoTag::AuthorDrop.name,Method,Jekyll/SeoTag/AuthorDrop.md#method-i-name
13
- Jekyll::SeoTag::AuthorDrop.to_s,Method,Jekyll/SeoTag/AuthorDrop.md#method-i-to_s
14
- Jekyll::SeoTag::AuthorDrop.twitter,Method,Jekyll/SeoTag/AuthorDrop.md#method-i-twitter
15
- Jekyll::SeoTag::Drop,Class,Jekyll/SeoTag/Drop.md
16
- Jekyll::SeoTag::Drop.new,Method,Jekyll/SeoTag/Drop.md#method-c-new
17
- Jekyll::SeoTag::Drop.version,Method,Jekyll/SeoTag/Drop.md#method-i-version
18
- Jekyll::SeoTag::Drop.title?,Method,Jekyll/SeoTag/Drop.md#method-i-title-3F
19
- Jekyll::SeoTag::Drop.site_title,Method,Jekyll/SeoTag/Drop.md#method-i-site_title
20
- Jekyll::SeoTag::Drop.site_tagline,Method,Jekyll/SeoTag/Drop.md#method-i-site_tagline
21
- Jekyll::SeoTag::Drop.site_description,Method,Jekyll/SeoTag/Drop.md#method-i-site_description
22
- Jekyll::SeoTag::Drop.page_title,Method,Jekyll/SeoTag/Drop.md#method-i-page_title
23
- Jekyll::SeoTag::Drop.site_tagline_or_description,Method,Jekyll/SeoTag/Drop.md#method-i-site_tagline_or_description
24
- Jekyll::SeoTag::Drop.title,Method,Jekyll/SeoTag/Drop.md#method-i-title
25
- Jekyll::SeoTag::Drop.name,Method,Jekyll/SeoTag/Drop.md#method-i-name
26
- Jekyll::SeoTag::Drop.description,Method,Jekyll/SeoTag/Drop.md#method-i-description
27
- Jekyll::SeoTag::Drop.author,Method,Jekyll/SeoTag/Drop.md#method-i-author
28
- Jekyll::SeoTag::Drop.json_ld,Method,Jekyll/SeoTag/Drop.md#method-i-json_ld
29
- Jekyll::SeoTag::Drop.image,Method,Jekyll/SeoTag/Drop.md#method-i-image
30
- Jekyll::SeoTag::Drop.date_modified,Method,Jekyll/SeoTag/Drop.md#method-i-date_modified
31
- Jekyll::SeoTag::Drop.date_published,Method,Jekyll/SeoTag/Drop.md#method-i-date_published
32
- Jekyll::SeoTag::Drop.type,Method,Jekyll/SeoTag/Drop.md#method-i-type
33
- Jekyll::SeoTag::Drop.links,Method,Jekyll/SeoTag/Drop.md#method-i-links
34
- Jekyll::SeoTag::Drop.logo,Method,Jekyll/SeoTag/Drop.md#method-i-logo
35
- Jekyll::SeoTag::Drop.page_lang,Method,Jekyll/SeoTag/Drop.md#method-i-page_lang
36
- Jekyll::SeoTag::Drop.page_locale,Method,Jekyll/SeoTag/Drop.md#method-i-page_locale
37
- Jekyll::SeoTag::Drop.canonical_url,Method,Jekyll/SeoTag/Drop.md#method-i-canonical_url
38
- Jekyll::SeoTag::Drop.FORMAT_STRING_METHODS,Constant,Jekyll/SeoTag/Drop.md#FORMAT_STRING_METHODS
39
- Jekyll::SeoTag::Drop.HOMEPAGE_OR_ABOUT_REGEX,Constant,Jekyll/SeoTag/Drop.md#HOMEPAGE_OR_ABOUT_REGEX
40
- Jekyll::SeoTag::Drop.TITLE_SEPARATOR,Constant,Jekyll/SeoTag/Drop.md#TITLE_SEPARATOR
41
- Jekyll::SeoTag::Filters,Class,Jekyll/SeoTag/Filters.md
42
- Jekyll::SeoTag::Filters.new,Method,Jekyll/SeoTag/Filters.md#method-c-new
43
- Jekyll::SeoTag::ImageDrop,Class,Jekyll/SeoTag/ImageDrop.md
44
- Jekyll::SeoTag::ImageDrop.new,Method,Jekyll/SeoTag/ImageDrop.md#method-c-new
45
- Jekyll::SeoTag::ImageDrop.path,Method,Jekyll/SeoTag/ImageDrop.md#method-i-path
46
- Jekyll::SeoTag::ImageDrop.to_s,Method,Jekyll/SeoTag/ImageDrop.md#method-i-to_s
47
- Jekyll::SeoTag::JSONLD,Module,Jekyll/SeoTag/JSONLD.md
48
- Jekyll::SeoTag::JSONLD.json_ld,Method,Jekyll/SeoTag/JSONLD.md#method-i-json_ld
49
- Jekyll::SeoTag::JSONLD.METHODS_KEYS,Constant,Jekyll/SeoTag/JSONLD.md#METHODS_KEYS
50
- Jekyll::SeoTag::JSONLDDrop,Class,Jekyll/SeoTag/JSONLDDrop.md
51
- Jekyll::SeoTag::JSONLDDrop.new,Method,Jekyll/SeoTag/JSONLDDrop.md#method-c-new
52
- Jekyll::SeoTag::JSONLDDrop.fallback_data,Method,Jekyll/SeoTag/JSONLDDrop.md#method-i-fallback_data
53
- Jekyll::SeoTag::JSONLDDrop.author,Method,Jekyll/SeoTag/JSONLDDrop.md#method-i-author
54
- Jekyll::SeoTag::JSONLDDrop.image,Method,Jekyll/SeoTag/JSONLDDrop.md#method-i-image
55
- Jekyll::SeoTag::JSONLDDrop.publisher,Method,Jekyll/SeoTag/JSONLDDrop.md#method-i-publisher
56
- Jekyll::SeoTag::JSONLDDrop.mainEntityOfPage,Method,Jekyll/SeoTag/JSONLDDrop.md#method-i-mainEntityOfPage
57
- Jekyll::SeoTag::JSONLDDrop.to_json,Method,Jekyll/SeoTag/JSONLDDrop.md#method-i-to_json
58
- Jekyll::SeoTag::UrlHelper,Module,Jekyll/SeoTag/UrlHelper.md
59
- Liquid,Module,Liquid.md
60
- Liquid::Tag,Class,Liquid/Tag.md
data/mutant.yml DELETED
@@ -1,15 +0,0 @@
1
- usage: opensource
2
-
3
- integration:
4
- name: minitest
5
-
6
- includes:
7
- - lib
8
- - test
9
-
10
- requires:
11
- - ./test/support/mutant.rb
12
-
13
- matcher:
14
- subjects:
15
- - RDoc::Generator::Markdown*
@@ -1,46 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- require_relative "lib/rdoc/markdown/version"
4
-
5
- Gem::Specification.new do |spec|
6
- spec.name = "rdoc-markdown"
7
- spec.version = Rdoc::Markdown::VERSION
8
- spec.authors = ["Stanislav (Stas) Katkov"]
9
- spec.email = ["github@skatkov.com"]
10
- spec.license = "GPL-3.0-or-later"
11
-
12
- spec.summary = "RDoc plugin to generate markdown documentation "
13
- spec.description = "RDoc plugin to generate markdown documentation and search index as sqlite database for entire content."
14
- spec.homepage = "https://poshtui.com"
15
- spec.required_ruby_version = ">= 3.3.0"
16
-
17
- # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
18
-
19
- spec.metadata["homepage_uri"] = spec.homepage
20
- spec.metadata["source_code_uri"] = "https://github.com/skatkov/rdoc-markdown"
21
- spec.metadata["changelog_uri"] = "https://github.com/skatkov/rdoc-markdown"
22
-
23
- # Specify which files should be added to the gem when it is released.
24
- # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
25
- spec.files = Dir.chdir(__dir__) do
26
- `git ls-files -z`.split("\x0").reject do |f|
27
- (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
28
- end
29
- end
30
- spec.bindir = "exe"
31
- spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
32
- spec.require_paths = ["lib"]
33
-
34
- spec.add_dependency "csv"
35
- spec.add_dependency "erb"
36
- spec.add_dependency "rdoc", ">= 8.0"
37
- spec.add_dependency "reverse_markdown"
38
-
39
- spec.add_development_dependency "bundler", ">= 2.0"
40
- spec.add_development_dependency "commonmarker"
41
- spec.add_development_dependency "minitest", "~> 5.0"
42
- spec.add_development_dependency "minitest-strict", "~> 1.0"
43
- spec.add_development_dependency "rake", "~> 13.0"
44
- spec.add_development_dependency "rdiscount", "~> 2.0"
45
- spec.add_development_dependency "simplecov", "~> 0.22"
46
- end