rdoc-markdown 0.17.2 → 0.19.0

data/example/index.csv

@@ -1,16 +0,0 @@
-name,type,path
-Bird,Class,Bird.md
-Bird.speak,Method,Bird.md#method-i-speak
-Bird.fly,Method,Bird.md#method-i-fly
-Duck,Class,Duck.md
-Duck.speak,Method,Duck.md#method-i-speak
-Duck.rubber_ducks,Method,Duck.md#method-c-rubber_ducks
-Duck.new,Method,Duck.md#method-c-new
-Duck.useful?,Method,Duck.md#method-i-useful-3F
-Duck.MAX_VELOCITY,Constant,Duck.md#MAX_VELOCITY
-Duck.domestic,Attribute,Duck.md#attribute-i-domestic
-Duck.rubber,Attribute,Duck.md#attribute-i-rubber
-Object,Class,Object.md
-Object.DEFAULT_DUCK_VELOCITY,Constant,Object.md#DEFAULT_DUCK_VELOCITY
-Waterfowl,Module,Waterfowl.md
-Waterfowl.swim,Method,Waterfowl.md#method-i-swim

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

@@ -1,35 +0,0 @@
-<a id="class-jekyll-seotag-authordrop"></a>
-# Class Jekyll::SeoTag::AuthorDrop
-A drop representing the current page’s author
-
-Author name will be pulled from:
-
-1. The page’s `author` key
-
-2. The first author in the page’s `authors` key
-
-3. The `author` key in the site config
-
-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)`
-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()`
-[`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()`
-Alias for: [`name`](#method-i-name)
-
-<a id="method-i-twitter"></a>
-#### `twitter()`
-Not documented.

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

@@ -1,108 +0,0 @@
-<a id="class-jekyll-seotag-drop"></a>
-# Class Jekyll::SeoTag::Drop
-
-### Constants
-
-<a id="FORMAT_STRING_METHODS"></a>
-#### `FORMAT_STRING_METHODS`
-Not documented.
-
-<a id="HOMEPAGE_OR_ABOUT_REGEX"></a>
-#### `HOMEPAGE_OR_ABOUT_REGEX`
-Not documented.
-
-<a id="TITLE_SEPARATOR"></a>
-#### `TITLE_SEPARATOR`
-Not documented.
-
-### Public Class Methods
-
-<a id="method-c-new"></a>
-#### `new(text, context)`
-Not documented.
-
-### Public Instance Methods
-
-<a id="method-i-author"></a>
-#### `author()`
-A drop representing the page author
-
-<a id="method-i-canonical_url"></a>
-#### `canonical_url()`
-Not documented.
-
-<a id="method-i-date_modified"></a>
-#### `date_modified()`
-Not documented.
-
-<a id="method-i-date_published"></a>
-#### `date_published()`
-Not documented.
-
-<a id="method-i-description"></a>
-#### `description()`
-Not documented.
-
-<a id="method-i-image"></a>
-#### `image()`
-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()`
-A drop representing the JSON-LD output
-
-<a id="method-i-links"></a>
-#### `links()`
-Not documented.
-
-<a id="method-i-logo"></a>
-#### `logo()`
-Not documented.
-
-<a id="method-i-name"></a>
-#### `name()`
-rubocop:enable Metrics/CyclomaticComplexity
-
-<a id="method-i-page_lang"></a>
-#### `page_lang()`
-Not documented.
-
-<a id="method-i-page_locale"></a>
-#### `page_locale()`
-Not documented.
-
-<a id="method-i-page_title"></a>
-#### `page_title()`
-Page title without site title or description appended
-
-<a id="method-i-site_description"></a>
-#### `site_description()`
-Not documented.
-
-<a id="method-i-site_tagline"></a>
-#### `site_tagline()`
-Not documented.
-
-<a id="method-i-site_tagline_or_description"></a>
-#### `site_tagline_or_description()`
-Not documented.
-
-<a id="method-i-site_title"></a>
-#### `site_title()`
-Not documented.
-
-<a id="method-i-title"></a>
-#### `title()`
-Page title with site title or description appended rubocop:disable Metrics/CyclomaticComplexity
-
-<a id="method-i-title-3F"></a>
-#### `title?()`
-Should the ‘\<title\>` tag be generated for this page?
-
-<a id="method-i-type"></a>
-#### `type()`
-Not documented.
-
-<a id="method-i-version"></a>
-#### `version()`
-Not documented.

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

@@ -1,8 +0,0 @@
-<a id="class-jekyll-seotag-filters"></a>
-# Class Jekyll::SeoTag::Filters
-
-### Public Class Methods
-
-<a id="method-c-new"></a>
-#### `new(context)`
-Not documented.

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

@@ -1,29 +0,0 @@
-<a id="class-jekyll-seotag-imagedrop"></a>
-# Class Jekyll::SeoTag::ImageDrop
-A drop representing the page image The image path will be pulled from:
-
-1. The `image` key if it’s a string
-
-2. The `image.path` key if it’s a hash
-
-3. The `image.facebook` key
-
-4. The `image.twitter` key
-
-### Public Class Methods
-
-<a id="method-c-new"></a>
-#### `new(page: nil, context: nil)`
-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()`
-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()`
-Alias for: [`path`](#method-i-path)

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

@@ -1,15 +0,0 @@
-<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
-
-### Constants
-
-<a id="METHODS_KEYS"></a>
-#### `METHODS_KEYS`
-Not documented.
-
-### Public Instance Methods
-
-<a id="method-i-json_ld"></a>
-#### `json_ld()`
-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 +0,0 @@
-<a id="class-jekyll-seotag-jsonlddrop"></a>
-# Class Jekyll::SeoTag::JSONLDDrop
-
-### Public Class Methods
-
-<a id="method-c-new"></a>
-#### `new(page_drop)`
-page\_drop should be an instance of [`Jekyll::SeoTag::Drop`](Drop.md)
-
-### Public Instance Methods
-
-<a id="method-i-author"></a>
-#### `author()`
-Not documented.
-
-<a id="method-i-fallback_data"></a>
-#### `fallback_data()`
-Not documented.
-
-<a id="method-i-image"></a>
-#### `image()`
-Not documented.
-
-<a id="method-i-mainEntityOfPage"></a>
-#### `mainEntityOfPage()`
-Alias for: [`main_entity`](#method-i-main_entity)
-
-<a id="method-i-publisher"></a>
-#### `publisher()`
-Not documented.
-
-<a id="method-i-to_json"></a>
-#### `to_json(state = nil)`
-Returns a JSON-encoded object containing the JSON-LD data. Keys are sorted.

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

@@ -1,4 +0,0 @@
-<a id="module-jekyll-seotag-urlhelper"></a>
-# Module Jekyll::SeoTag::UrlHelper
-Mixin to share common URL-related methods between class
-

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

@@ -1,48 +0,0 @@
-<a id="class-jekyll-seotag"></a>
-# Class Jekyll::SeoTag
-
-### Constants
-
-<a id="MINIFY_REGEX"></a>
-#### `MINIFY_REGEX`
-Matches all whitespace that follows either
-
-```
-1. A '}', which closes a Liquid tag
-2. A '{', which opens a JSON block
-3. A '>' followed by a newline, which closes an XML tag or
-4. A ',' followed by a newline, which ends a JSON line
-```
-
-We will strip all of this whitespace to minify the template We will not strip any whitespace if the next character is a ‘-’
-
-```
-so that we do not interfere with the HTML comment at the
-very begining
-```
-
-<a id="VERSION"></a>
-#### `VERSION`
-Not documented.
-
-### Attributes
-
-<a id="attribute-i-context"></a>
-#### `context` [RW]
-Not documented.
-
-### Public Class Methods
-
-<a id="method-c-new"></a>
-#### `new(_tag_name, text, _tokens)`
-Not documented.
-
-<a id="method-c-template"></a>
-#### `template()`
-Not documented.
-
-### Public Instance Methods
-
-<a id="method-i-render"></a>
-#### `render(context)`
-Not documented.

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

@@ -1,3 +0,0 @@
-<a id="module-jekyll"></a>
-# Module Jekyll
-

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

@@ -1,3 +0,0 @@
-<a id="class-liquid-tag"></a>
-# Class Liquid::Tag
-

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

@@ -1,4 +0,0 @@
-<a id="module-liquid"></a>
-# Module Liquid
-Prevent bundler errors
-

data/example/jekyll-seo-tag/index.csv

@@ -1,60 +0,0 @@
-name,type,path
-Jekyll,Module,Jekyll.md
-Jekyll::SeoTag,Class,Jekyll/SeoTag.md
-Jekyll::SeoTag.new,Method,Jekyll/SeoTag.md#method-c-new
-Jekyll::SeoTag.render,Method,Jekyll/SeoTag.md#method-i-render
-Jekyll::SeoTag.template,Method,Jekyll/SeoTag.md#method-c-template
-Jekyll::SeoTag.MINIFY_REGEX,Constant,Jekyll/SeoTag.md#MINIFY_REGEX
-Jekyll::SeoTag.VERSION,Constant,Jekyll/SeoTag.md#VERSION
-Jekyll::SeoTag.context,Attribute,Jekyll/SeoTag.md#attribute-i-context
-Jekyll::SeoTag::AuthorDrop,Class,Jekyll/SeoTag/AuthorDrop.md
-Jekyll::SeoTag::AuthorDrop.new,Method,Jekyll/SeoTag/AuthorDrop.md#method-c-new
-Jekyll::SeoTag::AuthorDrop.name,Method,Jekyll/SeoTag/AuthorDrop.md#method-i-name
-Jekyll::SeoTag::AuthorDrop.to_s,Method,Jekyll/SeoTag/AuthorDrop.md#method-i-to_s
-Jekyll::SeoTag::AuthorDrop.twitter,Method,Jekyll/SeoTag/AuthorDrop.md#method-i-twitter
-Jekyll::SeoTag::Drop,Class,Jekyll/SeoTag/Drop.md
-Jekyll::SeoTag::Drop.new,Method,Jekyll/SeoTag/Drop.md#method-c-new
-Jekyll::SeoTag::Drop.version,Method,Jekyll/SeoTag/Drop.md#method-i-version
-Jekyll::SeoTag::Drop.title?,Method,Jekyll/SeoTag/Drop.md#method-i-title-3F
-Jekyll::SeoTag::Drop.site_title,Method,Jekyll/SeoTag/Drop.md#method-i-site_title
-Jekyll::SeoTag::Drop.site_tagline,Method,Jekyll/SeoTag/Drop.md#method-i-site_tagline
-Jekyll::SeoTag::Drop.site_description,Method,Jekyll/SeoTag/Drop.md#method-i-site_description
-Jekyll::SeoTag::Drop.page_title,Method,Jekyll/SeoTag/Drop.md#method-i-page_title
-Jekyll::SeoTag::Drop.site_tagline_or_description,Method,Jekyll/SeoTag/Drop.md#method-i-site_tagline_or_description
-Jekyll::SeoTag::Drop.title,Method,Jekyll/SeoTag/Drop.md#method-i-title
-Jekyll::SeoTag::Drop.name,Method,Jekyll/SeoTag/Drop.md#method-i-name
-Jekyll::SeoTag::Drop.description,Method,Jekyll/SeoTag/Drop.md#method-i-description
-Jekyll::SeoTag::Drop.author,Method,Jekyll/SeoTag/Drop.md#method-i-author
-Jekyll::SeoTag::Drop.json_ld,Method,Jekyll/SeoTag/Drop.md#method-i-json_ld
-Jekyll::SeoTag::Drop.image,Method,Jekyll/SeoTag/Drop.md#method-i-image
-Jekyll::SeoTag::Drop.date_modified,Method,Jekyll/SeoTag/Drop.md#method-i-date_modified
-Jekyll::SeoTag::Drop.date_published,Method,Jekyll/SeoTag/Drop.md#method-i-date_published
-Jekyll::SeoTag::Drop.type,Method,Jekyll/SeoTag/Drop.md#method-i-type
-Jekyll::SeoTag::Drop.links,Method,Jekyll/SeoTag/Drop.md#method-i-links
-Jekyll::SeoTag::Drop.logo,Method,Jekyll/SeoTag/Drop.md#method-i-logo
-Jekyll::SeoTag::Drop.page_lang,Method,Jekyll/SeoTag/Drop.md#method-i-page_lang
-Jekyll::SeoTag::Drop.page_locale,Method,Jekyll/SeoTag/Drop.md#method-i-page_locale
-Jekyll::SeoTag::Drop.canonical_url,Method,Jekyll/SeoTag/Drop.md#method-i-canonical_url
-Jekyll::SeoTag::Drop.FORMAT_STRING_METHODS,Constant,Jekyll/SeoTag/Drop.md#FORMAT_STRING_METHODS
-Jekyll::SeoTag::Drop.HOMEPAGE_OR_ABOUT_REGEX,Constant,Jekyll/SeoTag/Drop.md#HOMEPAGE_OR_ABOUT_REGEX
-Jekyll::SeoTag::Drop.TITLE_SEPARATOR,Constant,Jekyll/SeoTag/Drop.md#TITLE_SEPARATOR
-Jekyll::SeoTag::Filters,Class,Jekyll/SeoTag/Filters.md
-Jekyll::SeoTag::Filters.new,Method,Jekyll/SeoTag/Filters.md#method-c-new
-Jekyll::SeoTag::ImageDrop,Class,Jekyll/SeoTag/ImageDrop.md
-Jekyll::SeoTag::ImageDrop.new,Method,Jekyll/SeoTag/ImageDrop.md#method-c-new
-Jekyll::SeoTag::ImageDrop.path,Method,Jekyll/SeoTag/ImageDrop.md#method-i-path
-Jekyll::SeoTag::ImageDrop.to_s,Method,Jekyll/SeoTag/ImageDrop.md#method-i-to_s
-Jekyll::SeoTag::JSONLD,Module,Jekyll/SeoTag/JSONLD.md
-Jekyll::SeoTag::JSONLD.json_ld,Method,Jekyll/SeoTag/JSONLD.md#method-i-json_ld
-Jekyll::SeoTag::JSONLD.METHODS_KEYS,Constant,Jekyll/SeoTag/JSONLD.md#METHODS_KEYS
-Jekyll::SeoTag::JSONLDDrop,Class,Jekyll/SeoTag/JSONLDDrop.md
-Jekyll::SeoTag::JSONLDDrop.new,Method,Jekyll/SeoTag/JSONLDDrop.md#method-c-new
-Jekyll::SeoTag::JSONLDDrop.fallback_data,Method,Jekyll/SeoTag/JSONLDDrop.md#method-i-fallback_data
-Jekyll::SeoTag::JSONLDDrop.author,Method,Jekyll/SeoTag/JSONLDDrop.md#method-i-author
-Jekyll::SeoTag::JSONLDDrop.image,Method,Jekyll/SeoTag/JSONLDDrop.md#method-i-image
-Jekyll::SeoTag::JSONLDDrop.publisher,Method,Jekyll/SeoTag/JSONLDDrop.md#method-i-publisher
-Jekyll::SeoTag::JSONLDDrop.mainEntityOfPage,Method,Jekyll/SeoTag/JSONLDDrop.md#method-i-mainEntityOfPage
-Jekyll::SeoTag::JSONLDDrop.to_json,Method,Jekyll/SeoTag/JSONLDDrop.md#method-i-to_json
-Jekyll::SeoTag::UrlHelper,Module,Jekyll/SeoTag/UrlHelper.md
-Liquid,Module,Liquid.md
-Liquid::Tag,Class,Liquid/Tag.md

data/mutant.yml

@@ -1,15 +0,0 @@
-usage: opensource
-
-integration:
-  name: minitest
-
-includes:
-  - lib
-  - test
-
-requires:
-  - ./test/support/mutant.rb
-
-matcher:
-  subjects:
-    - RDoc::Generator::Markdown*

data/rdoc-markdown.gemspec

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/rdoc/markdown/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "rdoc-markdown"
-  spec.version = Rdoc::Markdown::VERSION
-  spec.authors = ["Stanislav (Stas) Katkov"]
-  spec.email = ["github@skatkov.com"]
-  spec.license = "GPL-3.0-or-later"
-
-  spec.summary = "RDoc plugin to generate markdown documentation  "
-  spec.description = "RDoc plugin to generate markdown documentation and search index as sqlite database for entire content."
-  spec.homepage = "https://poshtui.com"
-  spec.required_ruby_version = ">= 3.3.0"
-
-  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/skatkov/rdoc-markdown"
-  spec.metadata["changelog_uri"] = "https://github.com/skatkov/rdoc-markdown"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "csv"
-  spec.add_dependency "erb"
-  spec.add_dependency "rdoc", ">= 8.0"
-  spec.add_dependency "reverse_markdown"
-
-  spec.add_development_dependency "bundler", ">= 2.0"
-  spec.add_development_dependency "commonmarker"
-  spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "minitest-strict", "~> 1.0"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rdiscount", "~> 2.0"
-  spec.add_development_dependency "simplecov", "~> 0.22"
-end