rdoc-markdown 0.18.0 → 0.19.0

data/Gemfile.lock

@@ -1,202 +0,0 @@
-PATH
-  remote: .
-  specs:
-    rdoc-markdown (0.18.0)
-      csv
-      erb
-      rdoc (>= 8.0)
-      reverse_markdown
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actionview (8.1.3)
-      activesupport (= 8.1.3)
-      builder (~> 3.1)
-      erubi (~> 1.11)
-      rails-dom-testing (~> 2.2)
-      rails-html-sanitizer (~> 1.6)
-    activesupport (8.1.3)
-      base64
-      bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.3.1)
-      connection_pool (>= 2.2.5)
-      drb
-      i18n (>= 1.6, < 2)
-      json
-      logger (>= 1.4.2)
-      minitest (>= 5.1)
-      securerandom (>= 0.3)
-      tzinfo (~> 2.0, >= 2.0.5)
-      uri (>= 0.13.1)
-    ast (2.4.3)
-    base64 (0.3.0)
-    better_html (2.2.0)
-      actionview (>= 7.0)
-      activesupport (>= 7.0)
-      ast (~> 2.0)
-      erubi (~> 1.4)
-      parser (>= 2.4)
-      smart_properties
-    bigdecimal (4.1.2)
-    builder (3.3.0)
-    commonmarker (2.8.1-x86_64-linux)
-    concurrent-ruby (1.3.6)
-    connection_pool (3.0.2)
-    crass (1.0.6)
-    csv (3.3.5)
-    diff-lcs (2.0.0)
-    docile (1.4.1)
-    drb (2.2.3)
-    erb (6.0.6)
-    erb_lint (0.9.0)
-      activesupport
-      better_html (>= 2.0.1)
-      parser (>= 2.7.1.4)
-      rainbow
-      rubocop (>= 1)
-      smart_properties
-    erubi (1.13.1)
-    i18n (1.14.8)
-      concurrent-ruby (~> 1.0)
-    io-console (0.8.2)
-    irb (1.18.0)
-      pp (>= 0.6.0)
-      prism (>= 1.3.0)
-      rdoc (>= 4.0.0)
-      reline (>= 0.4.2)
-    json (2.19.4)
-    language_server-protocol (3.17.0.5)
-    lint_roller (1.1.0)
-    logger (1.7.0)
-    loofah (2.25.1)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.12.0)
-    minitest (5.27.0)
-    minitest-strict (1.0.0)
-      minitest (>= 5.21, < 7)
-    mutant (0.16.2)
-      diff-lcs (>= 1.6, < 3)
-      irb (~> 1.15)
-      parser (~> 3.3.10)
-      regexp_parser (~> 2.10)
-      securerandom (>= 0.3)
-      sorbet-runtime (~> 0.6.0)
-      unparser (>= 0.8.2, < 0.10)
-    mutant-minitest (0.16.2)
-      minitest (>= 5.11, < 7)
-      mutant (= 0.16.2)
-      mutex_m (~> 0.2)
-    mutex_m (0.3.0)
-    nokogiri (1.19.2-x86_64-linux-gnu)
-      racc (~> 1.4)
-    parallel (1.28.0)
-    parser (3.3.11.1)
-      ast (~> 2.4.1)
-      racc
-    pp (0.6.3)
-      prettyprint
-    prettyprint (0.2.0)
-    prism (1.9.0)
-    racc (1.8.1)
-    rails-dom-testing (2.3.0)
-      activesupport (>= 5.0.0)
-      minitest
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.7.0)
-      loofah (~> 2.25)
-      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.2)
-      logger
-      prism (>= 1.6.0)
-      tsort
-    rdiscount (2.2.7.4)
-    rdoc (8.0.0)
-      erb
-      prism (>= 1.6.0)
-      rbs (>= 4.0.0)
-      tsort
-    regexp_parser (2.12.0)
-    reline (0.6.3)
-      io-console (~> 0.5)
-    reverse_markdown (3.0.2)
-      nokogiri
-    rubocop (1.84.2)
-      json (~> 2.3)
-      language_server-protocol (~> 3.17.0.2)
-      lint_roller (~> 1.1.0)
-      parallel (~> 1.10)
-      parser (>= 3.3.0.2)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.49.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.49.1)
-      parser (>= 3.3.7.2)
-      prism (~> 1.7)
-    rubocop-performance (1.26.1)
-      lint_roller (~> 1.1)
-      rubocop (>= 1.75.0, < 2.0)
-      rubocop-ast (>= 1.47.1, < 2.0)
-    ruby-progressbar (1.13.0)
-    securerandom (0.4.1)
-    simplecov (0.22.0)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.13.2)
-    simplecov_json_formatter (0.1.4)
-    smart_properties (1.17.0)
-    sorbet-runtime (0.6.13163)
-    standard (1.54.0)
-      language_server-protocol (~> 3.17.0.2)
-      lint_roller (~> 1.0)
-      rubocop (~> 1.84.0)
-      standard-custom (~> 1.0.0)
-      standard-performance (~> 1.8)
-    standard-custom (1.0.2)
-      lint_roller (~> 1.0)
-      rubocop (~> 1.50)
-    standard-performance (1.9.0)
-      lint_roller (~> 1.1)
-      rubocop-performance (~> 1.26.0)
-    tsort (0.2.0)
-    tzinfo (2.0.6)
-      concurrent-ruby (~> 1.0)
-    unicode-display_width (3.2.0)
-      unicode-emoji (~> 4.1)
-    unicode-emoji (4.2.0)
-    unparser (0.9.0)
-      diff-lcs (>= 1.6, < 3)
-      parser (>= 3.3.0)
-      prism (>= 1.5.1)
-    uri (1.1.1)
-    yard (0.9.43)
-    yard-lint (1.5.1)
-      yard (~> 0.9)
-      zeitwerk (~> 2.6)
-    zeitwerk (2.7.5)
-
-PLATFORMS
-  x86_64-linux-gnu
-
-DEPENDENCIES
-  bundler (>= 2.0)
-  commonmarker
-  erb_lint
-  minitest (~> 5.0)
-  minitest-strict (~> 1.0)
-  mutant
-  mutant-minitest
-  rake (~> 13.0)
-  rdiscount (~> 2.0)
-  rdoc-markdown!
-  simplecov (~> 0.22)
-  standard
-  yard-lint
-
-BUNDLED WITH
-  4.0.10

data/Rakefile

@@ -1,296 +0,0 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-require "fileutils"
-require "rdoc/rdoc"
-require "rdoc/markdown"
-require_relative "test/support/markdown_validator"
-
-JEKYLL_SEO_TAG_NAME = "jekyll-seo-tag"
-JEKYLL_SEO_TAG_REF = "v2.8.0"
-JEKYLL_SEO_TAG_TITLE = "#{JEKYLL_SEO_TAG_NAME} #{JEKYLL_SEO_TAG_REF.delete_prefix("v")}"
-JEKYLL_SEO_TAG_VENDOR_PATH = "vendor/#{JEKYLL_SEO_TAG_NAME}"
-
-Rake::TestTask.new do |t|
-  t.verbose = true
-  t.warning = false
-  t.test_files = FileList["test/test*.rb"]
-end
-
-task default: [:test]
-
-namespace :erb do
-  desc "Lint markdown ERB templates"
-  task :lint do
-    files = Dir["lib/templates/**/*.{md,markdown}.erb"]
-    raise "No markdown ERB templates found" if files.empty?
-
-    sh "bundle", "exec", "erb_lint", *files
-  end
-end
-
-namespace :markdown do
-  desc "Validate generated markdown as GitHub Flavored Markdown"
-  task :validate do
-    validation_root = File.expand_path("tmp/markdown-validate", __dir__)
-    FileUtils.rm_rf(validation_root)
-    FileUtils.mkdir_p(validation_root)
-
-    sample_output = File.join(validation_root, "sample")
-    generate_sample_docs(output: sample_output)
-
-    sample_count = MarkdownValidator.new(sample_output).validate!
-    puts "Validated #{sample_count} markdown files in #{sample_output}"
-
-    example_dir = File.expand_path("example", __dir__)
-    if Dir.exist?(example_dir)
-      example_count = MarkdownValidator.new(example_dir).validate!
-      puts "Validated #{example_count} markdown files in #{example_dir}"
-    end
-
-    Rake::Task["vendor:setup:minitest"].invoke
-    minitest_root = File.expand_path("vendor/minitest", __dir__)
-    minitest_output = File.join(validation_root, "minitest")
-    generate_markdown_docs(
-      title: "minitest",
-      root: minitest_root,
-      output: minitest_output,
-      files: minitest_docs_files(minitest_root)
-    )
-    minitest_count = MarkdownValidator.new(minitest_output).validate!
-    puts "Validated #{minitest_count} markdown files in #{minitest_output}"
-
-    Rake::Task["vendor:setup:reverse_markdown"].invoke
-    reverse_markdown_root = File.expand_path("vendor/reverse_markdown", __dir__)
-    reverse_markdown_output = File.join(validation_root, "reverse_markdown")
-    generate_markdown_docs(
-      title: "reverse_markdown",
-      root: reverse_markdown_root,
-      output: reverse_markdown_output,
-      files: reverse_markdown_docs_files(reverse_markdown_root)
-    )
-    reverse_markdown_count = MarkdownValidator.new(reverse_markdown_output).validate!
-    puts "Validated #{reverse_markdown_count} markdown files in #{reverse_markdown_output}"
-
-    Rake::Task["vendor:setup:jekyll_seo_tag"].invoke
-    jekyll_seo_tag_output = File.join(validation_root, JEKYLL_SEO_TAG_NAME)
-    generate_jekyll_seo_tag_docs(output: jekyll_seo_tag_output)
-    jekyll_seo_tag_count = MarkdownValidator.new(jekyll_seo_tag_output).validate!
-    puts "Validated #{jekyll_seo_tag_count} markdown files in #{jekyll_seo_tag_output}"
-
-    Rake::Task["vendor:setup:rails"].invoke
-    rails_root = File.expand_path("vendor/rails", __dir__)
-    rails_output = File.join(validation_root, "rails")
-    generate_markdown_docs(
-      title: "rails validation",
-      root: rails_root,
-      output: rails_output,
-      files: rails_validation_files(rails_root)
-    )
-    rails_count = MarkdownValidator.new(rails_output).validate!
-    puts "Validated #{rails_count} markdown files in #{rails_output}"
-
-    puts "Markdown validation artifacts written to #{validation_root}"
-  end
-end
-
-def ensure_git_checkout(path:, url:, ref: nil)
-  return if Dir.exist?(path)
-
-  FileUtils.mkdir_p(File.dirname(path))
-
-  clone_command = ["git", "clone", "--depth", "1"]
-  clone_command += ["--branch", ref] if ref
-  clone_command += [url, path]
-
-  sh clone_command.join(" ")
-end
-
-def generate_markdown_docs(title:, root:, output:, files:)
-  raise "No input files for #{title}" if files.empty?
-
-  FileUtils.rm_rf(output)
-  FileUtils.mkdir_p(output)
-
-  options = RDoc::Options.new
-  options.setup_generator("markdown")
-  options.verbosity = 0
-  options.files = files
-  options.op_dir = output
-  options.root = root
-  options.title = title
-  options.force_output = true
-
-  RDoc::RDoc.new.document(options)
-end
-
-def generate_sample_docs(output:)
-  generate_markdown_docs(
-    title: "sample",
-    root: File.expand_path("test/data", __dir__),
-    output: output,
-    files: [File.expand_path("test/data/example.rb", __dir__)]
-  )
-end
-
-def jekyll_seo_tag_root
-  File.expand_path(JEKYLL_SEO_TAG_VENDOR_PATH, __dir__)
-end
-
-def generate_jekyll_seo_tag_docs(output:)
-  root = jekyll_seo_tag_root
-  unless Dir.exist?(root)
-    raise "Missing #{JEKYLL_SEO_TAG_VENDOR_PATH}. Run `rake vendor:setup:jekyll_seo_tag` first."
-  end
-
-  generate_markdown_docs(
-    title: JEKYLL_SEO_TAG_TITLE,
-    root: root,
-    output: output,
-    files: Dir[File.join(root, "lib/**/*.rb")].uniq
-  )
-end
-
-namespace :examples do
-  desc "Generate checked-in example markdown docs"
-  task :generate do
-    Rake::Task["vendor:setup:jekyll_seo_tag"].invoke
-
-    sample_output = File.expand_path("example", __dir__)
-    staging_root = File.expand_path("tmp/examples-generate", __dir__)
-    staged_sample_output = File.join(staging_root, "example")
-
-    FileUtils.rm_rf(staging_root)
-    generate_sample_docs(output: staged_sample_output)
-    generate_jekyll_seo_tag_docs(output: File.join(staged_sample_output, JEKYLL_SEO_TAG_NAME))
-
-    FileUtils.rm_rf(sample_output)
-    FileUtils.mv(staged_sample_output, sample_output)
-
-    puts "Generated sample markdown docs in #{sample_output}"
-    puts "Generated #{JEKYLL_SEO_TAG_NAME} markdown docs in #{File.join(sample_output, JEKYLL_SEO_TAG_NAME)}"
-  ensure
-    FileUtils.rm_rf(staging_root) if staging_root
-  end
-end
-
-def minitest_docs_files(root)
-  files = Dir[File.join(root, "lib/**/*.rb")]
-  files.concat(Dir[File.join(root, "*.rdoc")])
-
-  files.uniq
-end
-
-def reverse_markdown_docs_files(root)
-  Dir[File.join(root, "lib/**/*.rb")] + Dir[File.join(root, "*.md")]
-end
-
-def rails_validation_files(root)
-  files = Dir[File.join(root, "activesupport/lib/**/*.rb")]
-  files.concat(Dir[File.join(root, "activerecord/lib/**/*.rb")])
-  files.concat(Dir[File.join(root, "actionpack/lib/**/*.rb")])
-  files.concat(Dir[File.join(root, "railties/lib/**/*.rb")])
-
-  files.concat(Dir[File.join(root, "{active*,action*,railties}/README.{rdoc,md,markdown}")])
-
-  files.uniq
-end
-
-namespace :vendor do
-  namespace :setup do
-    minitest_ref = "v6.0.1"
-    rails_ref = ENV.fetch("RAILS_REF", "main")
-    reverse_markdown_ref = "v3.0.2"
-
-    desc "Clone/update vendor/jekyll-seo-tag and checkout docs-aligned tag"
-    task :jekyll_seo_tag do
-      ensure_git_checkout(
-        path: JEKYLL_SEO_TAG_VENDOR_PATH,
-        url: "https://github.com/jekyll/jekyll-seo-tag.git",
-        ref: JEKYLL_SEO_TAG_REF
-      )
-      Dir.chdir(JEKYLL_SEO_TAG_VENDOR_PATH) do
-        sh "git fetch --tags --force"
-        sh "git checkout #{JEKYLL_SEO_TAG_REF}"
-      end
-    end
-
-    desc "Clone/update vendor/minitest and checkout docs-aligned tag"
-    task :minitest do
-      ensure_git_checkout(path: "vendor/minitest", url: "https://github.com/minitest/minitest.git", ref: minitest_ref)
-      Dir.chdir("vendor/minitest") { sh "git checkout #{minitest_ref}" }
-    end
-
-    desc "Clone/update vendor/rails"
-    task :rails do
-      ensure_git_checkout(path: "vendor/rails", url: "https://github.com/rails/rails.git", ref: rails_ref)
-    end
-
-    desc "Clone/update vendor/reverse_markdown and checkout dependency-aligned tag"
-    task :reverse_markdown do
-      ensure_git_checkout(
-        path: "vendor/reverse_markdown",
-        url: "https://github.com/xijo/reverse_markdown.git",
-        ref: reverse_markdown_ref
-      )
-      Dir.chdir("vendor/reverse_markdown") { sh "git checkout #{reverse_markdown_ref}" }
-    end
-  end
-
-  desc "Prepare all vendored repositories"
-  task setup: ["vendor:setup:jekyll_seo_tag", "vendor:setup:minitest", "vendor:setup:rails", "vendor:setup:reverse_markdown"]
-
-  namespace :docs do
-    desc "Generate markdown docs for vendored jekyll-seo-tag"
-    task :jekyll_seo_tag do
-      output = File.expand_path("vendor/docs/#{JEKYLL_SEO_TAG_NAME}", __dir__)
-      generate_jekyll_seo_tag_docs(output: output)
-      puts "Generated #{JEKYLL_SEO_TAG_NAME} markdown docs in #{output}"
-    end
-
-    desc "Generate markdown docs for vendored minitest"
-    task :minitest do
-      root = File.expand_path("vendor/minitest", __dir__)
-      raise "Missing vendor/minitest. Run `rake vendor:setup:minitest` first." unless Dir.exist?(root)
-
-      output = File.expand_path("vendor/docs/minitest", __dir__)
-      generate_markdown_docs(title: "minitest", root: root, output: output, files: minitest_docs_files(root))
-      puts "Generated minitest markdown docs in #{output}"
-    end
-
-    desc "Generate markdown docs for vendored reverse_markdown"
-    task :reverse_markdown do
-      root = File.expand_path("vendor/reverse_markdown", __dir__)
-      raise "Missing vendor/reverse_markdown. Run `rake vendor:setup:reverse_markdown` first." unless Dir.exist?(root)
-
-      output = File.expand_path("vendor/docs/reverse_markdown", __dir__)
-      generate_markdown_docs(
-        title: "reverse_markdown",
-        root: root,
-        output: output,
-        files: reverse_markdown_docs_files(root)
-      )
-      puts "Generated reverse_markdown markdown docs in #{output}"
-    end
-
-    desc "Generate markdown docs for vendored rails"
-    task :rails do
-      root = File.expand_path("vendor/rails", __dir__)
-      raise "Missing vendor/rails. Run `rake vendor:setup:rails` first." unless Dir.exist?(root)
-
-      files = Dir[File.join(root, "*/lib/**/*.rb")]
-
-      active_record_readme = File.join(root, "activerecord/README.rdoc")
-      files << active_record_readme if File.file?(active_record_readme)
-
-      output = File.expand_path("vendor/docs/rails", __dir__)
-      generate_markdown_docs(title: "rails", root: root, output: output, files: files)
-      puts "Generated rails markdown docs in #{output}"
-    end
-
-    desc "Generate markdown docs for all vendored repositories"
-    task all: [:jekyll_seo_tag, :minitest, :reverse_markdown, :rails]
-  end
-
-  desc "Generate markdown docs for all vendored repositories"
-  task docs: ["vendor:docs:all"]
-end

data/example/Bird.md

@@ -1,20 +0,0 @@
-# Class Bird<a id="class-bird"></a>
-|  |  |
-| --- | --- |
-| **Inherits** | [Object](Object.md) |
-| **Defined in** | example.rb |
-
-The base class for all birds.
-
-## 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<a id="method-i-fly-label-Example"></a><a id="method-i-fly-example"></a>
-```ruby
-fly(:south, 70)
-```
-### `speak() { |text| ... }`<a id="method-i-speak"></a>
-Produce some noise.

data/example/Duck.md

@@ -1,45 +0,0 @@
-# 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:
-
-bird:
-
-- speak
-- fly
-
-waterfowl:
-
-- swim
-
-## Bird overrides
-### Public Instance Methods
-#### `speak() { |speech| ... }`<a id="method-i-speak"></a>
-[`Duck`](Duck.md) overrides generic implementation.
-## Duck extensions
-### Constants
-#### `MAX_VELOCITY`<a id="MAX_VELOCITY"></a>
-Not documented.
-
-### Attributes
-#### `domestic` [RW]<a id="attribute-i-domestic"></a>
-True for domestic ducks.
-
-#### `rubber` [R]<a id="attribute-i-rubber"></a>
-True for rubber ducks.
-
-### Public Class Methods
-#### `new(domestic, rubber)`<a id="method-c-new"></a>
-Creates a new duck.
-#### `rubber_ducks()`<a id="method-c-rubber_ducks"></a>
-Returns list of all rubber ducks.
-
-### Public Instance Methods
-#### `useful? -> bool`<a id="method-i-useful-3F"></a>
-Checks if this duck is a useful one.

data/example/Object.md

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

data/example/Waterfowl.md

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

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,31 +0,0 @@
-# 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:
-
-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
-### `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
-### `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
-### `to_s()`<a id="method-i-to_s"></a>
-Alias for: [`name`](#method-i-name)
-### `twitter()`<a id="method-i-twitter"></a>
-Not documented.

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

@@ -1,64 +0,0 @@
-# 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
-### `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.