markdown_helper 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 95842873d7d0a15fbe01338a241d0e26e8426420
-  data.tar.gz: f507e95dfbd4cf7ab169d7551d0663e99da5410c
+  metadata.gz: d13b25bca8211a7b125220f43823d929aa063f18
+  data.tar.gz: 5abf171a884b8a945bd5a53b3c20db59eda73079
 SHA512:
-  metadata.gz: eb20e2c5abb5e62e3a02af6286863af515ec2b095c45045445cb36704f61753884144a4ea17612045419fef0a9182436e0f11d2f140d128549f4751410df9715
-  data.tar.gz: 2e97cdc6a7e3389f8d4f84bda8ae2397885990ee5b8809062cfa30103d4ae6dbf28a3abcdecac7da3facd78969bb6345a218f814962f5d60e023d40127dc2324
+  metadata.gz: d806efe553b5be7c0b029f1010f51a714d92399cd55e42ff54ccf8361cefa5f4daa7614ecfc4ec034aca729dd7248378de2288652947a30e6feda5dd762df865
+  data.tar.gz: c27d30e13ac8eb24b5c95b857c103c3b1c0dfe9c7907c68ecbf47b442b6622173d6ae4d05786821d3a0fb0d182cae09db83b79683b3c69e6886b584ef63c26cd

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    markdown_helper (0.2.1)
+    markdown_helper (0.2.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -6,6 +6,7 @@ Class <code>MarkdownHelper</code> supports:
 
 * [File inclusion](#file-inclusion): to include text from other files, as code-block or markdown.
 * [Image path resolution](#image-path-resolution): to resolve relative image paths to absolute URL paths (so they work even in gem documentation).
+* [Image attributes](#image-attrubutes): image attributes are passed through to an HTML <code>img</code> tag.
 
 Next feature:
 
@@ -84,9 +85,9 @@ markdown_file_path = 'highlighted_ruby.md'
 markdown_helper.include(template_file_path, markdown_file_path)
 ```
 
-#### Include Pragmas
+#### Include Descriptions
 
-Specify each file inclusion via an *include pragma*, which has the form:
+Specify each file inclusion via an *include description*, which has the form:
 
 <code>@[</code>*format*<code>]\(</code>*relative_file_path*<code>)</code>
 
@@ -98,7 +99,7 @@ where:
   * <code>[:verbatim]</code>, to include text verbatim (to be rendered as markdown).
 * *relative_file_path* points to the file to be included.
 
-##### Example Include Pragmas
+##### Example Include Descriptions
 
 <code>include.md</code>
 ```code_block
@@ -154,9 +155,75 @@ markdown_file_path = 'markdown.md'
 markdown_helper.resolve_image_urls(template_file_path, markdown_file_path)
 ```
 
-#### Image Pragmas
+#### Image Descriptions
 
-Specify each image file via an *image pragma*, which has the form:
+Specify each image via an *image description*, which has the form:
+
+<code>![*alt_text*]\(</code>*relative_file_path* <code>|</code> *attributes*<code>)</code>
+
+where:
+
+* *alt_text* is the usual alt text for an HTML image.
+* *relative_file_path* points to the file to be included.
+* *attributes* specify image attributes.  See [Image Attributes](#image-attributes) below.
+
+##### Example Image Descriptions
+
+<code>resolve_image_urls.md</code>
+```code_block
+ ![my_alt](image/image.png)
+
+ ![my_alt](image/image.png | width=50)
+
+ ![my_alt](image/image.png| width=50 height=50)
+```
+
+## Image Attributes
+
+<img src="https://raw.githubusercontent.com/BurdetteLamar/MarkdownHelper/master/images/html.png" alt="html_icon" width="50">
+
+This markdown helper enables HTML image attributes in GitHub markdown [image descriptions](https://github.github.com/gfm/#image-description).
+
+(Actually, this README file itself is built using image attributes.)
+
+Use the markdown helper to add image attributes in a markdown (</code>.md</code>) file.
+
+### Usage
+
+#### CLI
+
+<code>resolve_image_urls.txt</code>
+```
+Usage:
+
+  resolve_image_urls template_file_path markdown_file_page
+
+  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 relative file paths.  See README.md.
+```
+
+#### API
+
+<code>resolve_image_urls_usage.rb</code>
+```ruby
+require 'markdown_helper'
+
+markdown_helper = MarkdownHelper.new
+template_file_path = 'template.md'
+markdown_file_path = 'markdown.md'
+markdown_helper.resolve_image_urls(template_file_path, markdown_file_path)
+```
+
+#### Image Descriptions
+
+Specify each image via an *image description*, which has the form:
 
 <code>![*alt_text*]\(</code>*relative_file_path* <code>|</code> *attributes*<code>)</code>
 
@@ -166,7 +233,7 @@ where:
 * *relative_file_path* points to the file to be included.
 * *attributes* are whitespace-separated name-value pairs in the form *name*<code>=</code>*value*.  These are passed through to the generated <code>img</code> HTML element.
 
-##### Example Image Pragmas
+##### Example Image Descriptions
 
 <code>resolve_image_urls.md</code>
 ```code_block

data/lib/markdown_helper/version.rb

@@ -1,3 +1,3 @@
 class MarkdownHelper
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

data/markdown_helper.gemspec

@@ -10,7 +10,13 @@ Gem::Specification.new do |spec|
   spec.email         = ['BurdetteLamar@Yahoo.com']
 
   spec.summary       = 'Class to help with GitHub markdown.'
-  spec.description   = 'Class to help with GitHub markdown.  So far:  file inclusion.'
+  spec.description   = <<-EOT
+Class to help with GitHub markdown:
+
+* File inclusion
+* Image path resolution
+* Image attributes
+EOT
   spec.homepage      = 'https://github.com/BurdetteLamar/MarkdownHelper'
   spec.license       = 'MIT'
 

data/readme_files/README.template.md

@@ -6,6 +6,7 @@ Class <code>MarkdownHelper</code> supports:
 
 * [File inclusion](#file-inclusion): to include text from other files, as code-block or markdown.
 * [Image path resolution](#image-path-resolution): to resolve relative image paths to absolute URL paths (so they work even in gem documentation).
+* [Image attributes](#image-attrubutes): image attributes are passed through to an HTML <code>img</code> tag.
 
 Next feature:
 
@@ -47,9 +48,9 @@ Verbatim text is included unadorned.  Most often, verbatim text is markdown to b
 
 @[ruby](include_usage.rb)
 
-#### Include Pragmas
+#### Include Descriptions
 
-Specify each file inclusion via an *include pragma*, which has the form:
+Specify each file inclusion via an *include description*, which has the form:
 
 <code>@[</code>*format*<code>]\(</code>*relative_file_path*<code>)</code>
 
@@ -61,7 +62,7 @@ where:
   * <code>[:verbatim]</code>, to include text verbatim (to be rendered as markdown).
 * *relative_file_path* points to the file to be included.
 
-##### Example Include Pragmas
+##### Example Include Descriptions
 
 @[code_block](include.md)
 
@@ -87,9 +88,45 @@ This matters because when markdown becomes part of a Ruby gem, its images will h
 
 @[ruby](resolve_image_urls_usage.rb)
 
-#### Image Pragmas
+#### Image Descriptions
 
-Specify each image file via an *image pragma*, which has the form:
+Specify each image via an *image description*, which has the form:
+
+<code>![*alt_text*]\(</code>*relative_file_path* <code>|</code> *attributes*<code>)</code>
+
+where:
+
+* *alt_text* is the usual alt text for an HTML image.
+* *relative_file_path* points to the file to be included.
+* *attributes* specify image attributes.  See [Image Attributes](#image-attributes) below.
+
+##### Example Image Descriptions
+
+@[code_block](resolve_image_urls.md)
+
+## Image Attributes
+
+![html_icon](images/html.png | width=50)
+
+This markdown helper enables HTML image attributes in GitHub markdown [image descriptions](https://github.github.com/gfm/#image-description).
+
+(Actually, this README file itself is built using image attributes.)
+
+Use the markdown helper to add image attributes in a markdown (</code>.md</code>) file.
+
+### Usage
+
+#### CLI
+
+@[:code_block](../bin/usage/resolve_image_urls.txt)
+
+#### API
+
+@[ruby](resolve_image_urls_usage.rb)
+
+#### Image Descriptions
+
+Specify each image via an *image description*, which has the form:
 
 <code>![*alt_text*]\(</code>*relative_file_path* <code>|</code> *attributes*<code>)</code>
 
@@ -99,7 +136,7 @@ where:
 * *relative_file_path* points to the file to be included.
 * *attributes* are whitespace-separated name-value pairs in the form *name*<code>=</code>*value*.  These are passed through to the generated <code>img</code> HTML element.
 
-##### Example Image Pragmas
+##### Example Image Descriptions
 
 @[code_block](resolve_image_urls.md)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: markdown_helper
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - burdettelamar
@@ -66,7 +66,12 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-description: 'Class to help with GitHub markdown.  So far:  file inclusion.'
+description: |
+  Class to help with GitHub markdown:
+
+  * File inclusion
+  * Image path resolution
+  * Image attributes
 email:
 - BurdetteLamar@Yahoo.com
 executables: []
@@ -88,6 +93,7 @@ files:
 - bin/setup
 - bin/usage/include.txt
 - bin/usage/resolve_image_urls.txt
+- images/html.png
 - images/image.png
 - images/include.png
 - images_resolved.md