markdown_helper 2.0.0 → 2.1.0

data/bin/resolve

@@ -1,49 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'optparse'
-
-require 'markdown_helper'
-
-options = {:pristine => false}
-
-# Save opts for use below.
-opts = nil
-parser = OptionParser.new do |_opts|
-  opts = _opts
-  _opts.banner = "Usage: #{File.basename(__FILE__)} [options] template_file_path markdown_file_path"
-  _opts.on('--pristine', 'No comments added') do |_|
-    options[:pristine] = true
-  end
-  _opts.on('--help', 'Display help') do
-    usage(_opts)
-  end
-end
-
-def usage(opts)
-  puts ''
-  puts opts
-  puts <<-EOT
-    
-  where
-
-    * template_file_path is the path to an existing file.
-    * markdown_file_path is the path to a file to be created.
-
-  Typically:
-
-    * Both file types are .md.
-    * The template file contains image descriptions.
-  EOT
-  exit
-end
-
-parser.parse!
-
-template_file_path, markdown_file_path = ARGV
-
-usage(opts) unless ARGV.size == 2
-usage(opts) unless File.readable?(template_file_path)
-usage(opts) unless File.writable?(File.dirname(markdown_file_path))
-
-warn('This resolve is deprecated.  Please use command "markdown_helper resolve".')
-MarkdownHelper.new(options).resolve(template_file_path, markdown_file_path)

data/bin/usage/resolve.txt

@@ -1,14 +0,0 @@
-
-Usage: markdown_helper resolve [options] template_file_path markdown_file_path
-        --pristine                   No comments added
-        --help                       Display help
-    
-  where
-
-    * template_file_path is the path to an existing file.
-    * markdown_file_path is the path to a file to be created.
-
-  Typically:
-
-    * Both file types are .md.
-    * The template file contains image descriptions.

data/markdown/readme/resolve_usage.rb

@@ -1,12 +0,0 @@
-require 'markdown_helper'
-
-template_file_path = 'template.md'
-markdown_file_path = 'markdown.md'
-markdown_helper = MarkdownHelper.new
-markdown_helper.resolve(template_file_path, markdown_file_path)
-# Pristine.
-markdown_helper.pristine = true
-markdown_helper.resolve(template_file_path, markdown_file_path)
-# Also pristine.
-markdown_helper = MarkdownHelper.new(:pristine => true)
-markdown_helper.resolve(template_file_path, markdown_file_path)

data/markdown/use_cases/include_files/diagnose_missing_includee/included.md

@@ -1 +0,0 @@
-@[:markdown](includer_1.md}

data/markdown/use_cases/resolve/gemify_images/gemify_images.md

@@ -1,11 +0,0 @@
-### Gemify Images
-
-Use the markdown helper to resolve image paths for a Ruby gem.
-
-When you release your GitHub project to  gem at RubyGems.org, the documentation is rebuilt into files on RubyDoc.info.  When YARD performs this rebuilding, it does some directory restructuring.
-
-If a markdown file contains an image description that has a relative file path, that path will not be valid in the documentation on RubyDoc.info, and the image will not display in the documentation.
-
-To avoid that error, use the markdown helper to resolve the relative path to an absolute path.
-
-This new absolute path points to a file that's automatically maintained in the GitHub project.  For that reason,

data/markdown/use_cases/resolve/gemify_images/gemify_images.rb

@@ -1,68 +0,0 @@
-require_relative '../../use_case'
-
-class GemifyImages < UseCase
-
-  def self.build
-
-    use_case_dir_path = File.absolute_path(File.dirname(__FILE__))
-
-    use_case = self.new(use_case_dir_path)
-
-    reusable_text_file_name = 'reusable_text.md'
-    includer_file_name = 'includer.md'
-    included_file_name = 'included.md'
-
-    resolve_command = use_case.construct_resolve_command(includer_file_name, included_file_name, pristine = true)
-    build_command = use_case.construct_include_command(TEMPLATE_FILE_NAME, USE_CASE_FILE_NAME, pristine = true)
-
-    use_case.commands_to_execute.push(
-        resolve_command,
-        build_command,
-    )
-
-#
-#     relative_image_file_name = 'relative_image.md'
-# absolute_image_file_name = 'resolved_image.md'
-# template_file_name = 'template.md'
-# use_case_file_name = 'gemify_images.md'
-#
-# resolve_command = "markdown_helper resolve --pristine #{relative_image_file_name} #{absolute_image_file_name}"
-#
-# File.write(
-#     relative_image_file_name,
-#     <<EOT
-# ![html_image](../../../images/html.png)
-# EOT
-# )
-#
-# # Example resolution.
-# # system(resolve_command)
-#
-# File.write(
-#     template_file_name,
-#     <<EOT
-# ### Gemify Images
-#
-# Use the markdown helper to resolve image paths for a Ruby gem.
-#
-# #### The Problem
-#
-# When you release your GitHub project to  gem at RubyGems.org, the documentation is rebuilt into files on RubyDoc.info.  When YARD performs this rebuilding, it does some directory restructuring.
-#
-# If a markdown file contains an image description that has a relative file path, that path will not be valid in the documentation on RubyDoc.info, and the image will not display in the documentation.
-#
-# #### The Solution
-#
-# To avoid that error, use the markdown helper to resolve the relative path to an absolute path.
-#
-# This new absolute path points to a file that's automatically maintained in the GitHub project.  For that reason,
-# EOT
-# )
-#
-# # Build use case.
-# # build_command = "markdown_helper include --pristine #{template_file_name} #{use_case_file_name}"
-# # system(build_command)
-
-  end
-
-end

data/markdown/use_cases/resolve/gemify_images/relative_image.md

@@ -1 +0,0 @@
-![html_image](../../../images/html.png)

data/markdown/use_cases/resolve/gemify_images/resolved_image.md

@@ -1 +0,0 @@
-<img src="" alt="html_image">

data/markdown/use_cases/resolve/gemify_images/template.md

@@ -1,15 +0,0 @@
-### Gemify Images
-
-Use the markdown helper to resolve image paths for a Ruby gem.
-
-#### The Problem
-
-When you release your GitHub project to  gem at RubyGems.org, the documentation is rebuilt into files on RubyDoc.info.  When YARD performs this rebuilding, it does some directory restructuring.
-
-If a markdown file contains an image description that has a relative file path, that path will not be valid in the documentation on RubyDoc.info, and the image will not display in the documentation.
-
-#### The Solution
-
-To avoid that error, use the markdown helper to resolve the relative path to an absolute path.
-
-This new absolute path points to a file that's automatically maintained in the GitHub project.  For that reason,

data/markdown/use_cases/resolve/resize_images/template.md

@@ -1,8 +0,0 @@
-### Image Attributes
-
-Use the markdown helper to assign attributes to images.
-
-If you're using the markdown helper to [resolve image file paths for a Ruby gem](./rubygem_images.md), you'll be using the GitHub markdown image-description idiom (begins with exclamation point), and not the HTML <code>img</code> idiom.
-
-The image description does not accept attributes (such as height and width), but the markdown helper does accept those, passing them through to an <code>img</code> HTML element.
-s