readme_files/README.template.md in markdown_helper-0.2.1 vs readme_files/README.template.md in markdown_helper-0.2.2
- old
+ new
@@ -4,10 +4,11 @@
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:
* "Slide deck": to chain markdown pages into a series with next/prev navigation links.
@@ -45,13 +46,13 @@
#### API
@[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>
where:
@@ -59,11 +60,11 @@
* Highlighting mode such as <code>[ruby]</code>, to include a highlighted code block. This can be any Ace mode mentioned in [GitHub Languages](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml).
* <code>[:code_block]</code>, to include a plain code block.
* <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)
## Image Path Resolution
@@ -85,21 +86,57 @@
#### API
@[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>
+
+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
+##### Example Image Descriptions
@[code_block](resolve_image_urls.md)