rdoc-markdown 0.6.0 → 0.8.0

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

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

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

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

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

@@ -0,0 +1,33 @@
+# Class Jekyll::SeoTag::ImageDrop
+<a id="class-jekyll-seotag-imagedrop"></a>
+
+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
+
+#### `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
+
+#### `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
+
+#### `to_s()`
+<a id="method-i-to_s"></a>
+
+Alias for: [`path`](#method-i-path)

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

@@ -0,0 +1,18 @@
+# Module Jekyll::SeoTag::JSONLD
+<a id="module-jekyll-seotag-jsonld"></a>
+
+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
+
+#### `METHODS_KEYS`
+<a id="METHODS_KEYS"></a>
+
+Not documented.
+
+### 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

@@ -0,0 +1,41 @@
+# Class Jekyll::SeoTag::JSONLDDrop
+<a id="class-jekyll-seotag-jsonlddrop"></a>
+
+### 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
+
+#### `author()`
+<a id="method-i-author"></a>
+
+Not documented.
+
+#### `fallback_data()`
+<a id="method-i-fallback_data"></a>
+
+Not documented.
+
+#### `image()`
+<a id="method-i-image"></a>
+
+Not documented.
+
+#### `mainEntityOfPage()`
+<a id="method-i-mainEntityOfPage"></a>
+
+Alias for: [`main_entity`](#method-i-main_entity)
+
+#### `publisher()`
+<a id="method-i-publisher"></a>
+
+Not documented.
+
+#### `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

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

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

@@ -0,0 +1,54 @@
+# Class Jekyll::SeoTag
+<a id="class-jekyll-seotag"></a>
+
+### Constants
+
+#### `MINIFY_REGEX`
+<a id="MINIFY_REGEX"></a>
+
+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
+```
+
+#### `VERSION`
+<a id="VERSION"></a>
+
+Not documented.
+
+### Attributes
+
+#### `context` [RW]
+<a id="attribute-i-context"></a>
+
+Not documented.
+
+### Public Class Methods
+
+#### `new(_tag_name, text, _tokens)`
+<a id="method-c-new"></a>
+
+Not documented.
+
+#### `template()`
+<a id="method-c-template"></a>
+
+Not documented.
+
+### Public Instance Methods
+
+#### `render(context)`
+<a id="method-i-render"></a>
+
+Not documented.

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

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

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

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

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

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

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

@@ -0,0 +1,60 @@
+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/gemfiles/rdoc_head.gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+eval_gemfile "../Gemfile"
+
+gem "rdoc", git: "https://github.com/ruby/rdoc.git", branch: "master"

data/lib/markdown.rb

@@ -2,5 +2,6 @@
 
 require "rdoc/generator/markdown"
 
+# Compatibility namespace loaded by RDoc's generator discovery.
 class RDoc::Markdown
 end