markdown_helper 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f09669b50665a49012e58c114423d8cadbabdd78
-  data.tar.gz: 5e7efd7f10b45d9e55800be245016d8c221451ba
+  metadata.gz: 128fe00dd89389615391ceb4cc69127317a7249b
+  data.tar.gz: bc50bd8214659764a83503c2a02f36a8c5795ec7
 SHA512:
-  metadata.gz: 97c756477a554d5b64800c58154a329512817134004a72ea8daa458190ca13332b93844b4810fcbf41b77f85ac5af3991a03d39b39b7053d6aa723aa6ff2217c
-  data.tar.gz: 5ddf37cb2ab123d4cc24d6aa60f1a45fea125774cb608e06cb2e8a8138b3e9a923d95c2f953586130ac8ecc971ca525de449c8a3088b0959d2c701d3791ab598
+  metadata.gz: 6b11b8fc50ede26c160679b2fa750653e8f1b78e84b824052c233a53a35d2672812b322e76aab382e3476fa5c0ba1c21935fecc154cefd7bd22c54cc38cb11eb
+  data.tar.gz: efe58d2174a05141b743346b0a9fe043681fcd30f13111400d67c25b5015e5bbdfd771116d9cc64c4db3724061130af82ecaee2817f39a2de6c85e4ffd6ef203

data/Gemfile.lock

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

data/README.md

@@ -2,17 +2,15 @@
 <!-- >>>>>> BEGIN GENERATED FILE (resolve): SOURCE readme_files/README.template.md -->
 # 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.
-
-Next feature:
-
-* "Slide deck": to chain markdown pages into a series with next/prev navigation links.
+* [Image attributes](#image-attributes): image attributes are passed through to an HTML <code>img</code> tag.
 
 ## How It Works
 
@@ -20,6 +18,8 @@ The markdown helper reads a markdown document (template) and writes another mark
 
 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.
@@ -27,6 +27,7 @@ By default, the output markdown has added comments that show:
 * The image description (original) for each resolved image file path.
 
 You can suppress those comments using the <code>pristine</code> option.
+
 ## File Inclusion 
 
 <!-- >>>>>> BEGIN RESOLVED IMAGE: DESCRIPTION '![include_icon](images/include.png | width=50)
@@ -315,5 +316,16 @@ where:
 ```
 <!-- <<<<<< END INCLUDED FILE (code_block): SOURCE readme_files/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).
 <!-- <<<<<< END GENERATED FILE (resolve): SOURCE readme_files/README.template.md -->
 <!-- <<<<<< END GENERATED FILE (include): SOURCE readme_files/temp_resolved.md -->

data/lib/markdown_helper/version.rb

@@ -1,3 +1,3 @@
 class MarkdownHelper
-  VERSION = '0.2.3'
+  VERSION = '0.2.4'
 end

data/readme_files/README.template.md

@@ -1,16 +1,14 @@
 # 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.
-
-Next feature:
-
-* "Slide deck": to chain markdown pages into a series with next/prev navigation links.
+* [Image attributes](#image-attributes): image attributes are passed through to an HTML <code>img</code> tag.
 
 ## How It Works
 
@@ -18,6 +16,8 @@ The markdown helper reads a markdown document (template) and writes another mark
 
 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.
@@ -25,6 +25,7 @@ By default, the output markdown has added comments that show:
 * 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)
@@ -157,3 +158,14 @@ where:
 
 @[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).

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_helper
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - burdettelamar
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-14 00:00:00.000000000 Z
+date: 2018-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler