readme_files/README.template.md in markdown_helper-1.0.0 vs readme_files/README.template.md in markdown_helper-1.5.0
- old
+ new
@@ -1,24 +1,28 @@
# Markdown Helper
![Gem Version](https://badge.fury.io/rb/markdown_helper.svg)
+## What's New?
+
+Nested file inclusion is now supported, which means that an included file can include more files. This applies only to a file included verbatim, not to a file included as a code block or as a markdown comment.
+
## What's This?
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-attributes): image attributes are passed through to an HTML <code>img</code> tag.
## How It Works
-The markdown helper reads a markdown document (template) and writes another markdown document.
+The markdown helper is a preprocessor that reads a markdown document (template) and writes another markdown document.
The template can contain certain instructions that call for file inclusions and image resolutions.
-## Commented or Pristine?
+### Commented or Pristine?
By default, the output markdown has added comments that show:
* The path to the template file.
* The path to each included file.
@@ -53,9 +57,11 @@
Comment text is written into the output between the comment delimiters <code>\<!--</code> and <code>--></code>
#### Verbatim
Verbatim text is included unadorned. Most often, verbatim text is markdown to be rendered as part of the markdown page.
+
+The verbatim text is itself scanned for nested includes.
### Usage
#### CLI