readme_files/README.template.md in markdown_helper-0.1.8 vs readme_files/README.template.md in markdown_helper-0.1.9

- old
+ new

@@ -2,11 +2,11 @@ [![Gem Version](https://badge.fury.io/rb/markdown_helper.svg)](https://badge.fury.io/rb/markdown_helper) ## File Inclusion -<img src="https://raw.githubusercontent.com/BurdetteLamar/MarkdownHelper/master/images/include.png" width="50"> +![include_icon](images/include.png | width=50) This markdown helper enables file inclusion in GitHub markdown. (Actually, this README file itself is built using file inclusion.) @@ -34,11 +34,11 @@ @[:code_block](../bin/usage/include.txt) #### API -@[ruby](usage.rb) +@[ruby](include_usage.rb) #### Include Pragmas Specify each file inclusion via an *include pragma*, which has the form: @@ -52,8 +52,45 @@ * <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 -@[verbatim](include.md) +@[code_block](include.md) +## Image Path Resolution + +![image_icon](images/image.png | width=50) + +This markdown helper enables image path resolution in GitHub markdown. + +(Actually, this README file itself is built using image path resolution.) + +Use the markdown helper to resolve image relative paths in a markdown (</code>.md</code>) file. + +This matters because when markdown becomes part of a Ruby gem, its images will have been relocated in the documentation at RubyDoc.info, breaking the relative paths. The resolved (absolute) urls, however, will still be valid. + +### Usage + +#### CLI + +@[:code_block](../bin/usage/resolve_image_urls.txt) + +#### API + +@[ruby](resolve_image_urls_usage.rb) + +#### Image Pragmas + +Specify each image file via an *image pragma*, 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* 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 + +@[code_block](resolve_image_urls.md)