readme_files/README.template.md in markdown_helper-0.2.3 vs readme_files/README.template.md in markdown_helper-0.2.4

- old
+ new

@@ -1,32 +1,33 @@ # MarkdownHelper +## What's This? + [![Gem Version](https://badge.fury.io/rb/markdown_helper.svg)](https://badge.fury.io/rb/markdown_helper) 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. +* [Image attributes](#image-attributes): 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. - ## How It Works The markdown helper 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? + By default, the output markdown has added comments that show: * The path to the template file. * The path to each included file. * The image description (original) for each resolved image file path. You can suppress those comments using the <code>pristine</code> option. + ## File Inclusion ![include_icon](images/include.png | width=50) This markdown helper enables file inclusion in GitHub markdown. @@ -155,5 +156,16 @@ ##### Example Image Descriptions @[code_block](resolve.md) +## What Should Be Next? + +I have opened some enhancement Issues in the GitHub [MarkdownHelper](https://github.com/BurdetteLamar/MarkdownHelper) project: + +* [Pagination](https://github.com/BurdetteLamar/MarkdownHelper/issues/40): series of markdown pages connected by prev/next navigation links. +* [Partial file inclusion](https://github.com/BurdetteLamar/MarkdownHelper/issues/38): including only specified lines from a file (instead of the whole file). +* [Ruby-entity inclusion](https://github.com/BurdetteLamar/MarkdownHelper/issues/39): like file inclusion, but including a Ruby class, module, or method. +* [File TOC](https://github.com/BurdetteLamar/MarkdownHelper/issues/36): table of contents of all headers in a markdown page. +* [Project TOC](https://github.com/BurdetteLamar/MarkdownHelper/issues/37): table of contents of all markdown pages in project. + +Feel free to comment on any of these, or to add more Issues (enhancement or otherwise).