markdown_helper 0.2.3 → 0.2.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +17 -5
- data/lib/markdown_helper/version.rb +1 -1
- data/readme_files/README.template.md +17 -5
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 128fe00dd89389615391ceb4cc69127317a7249b
|
4
|
+
data.tar.gz: bc50bd8214659764a83503c2a02f36a8c5795ec7
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6b11b8fc50ede26c160679b2fa750653e8f1b78e84b824052c233a53a35d2672812b322e76aab382e3476fa5c0ba1c21935fecc154cefd7bd22c54cc38cb11eb
|
7
|
+
data.tar.gz: efe58d2174a05141b743346b0a9fe043681fcd30f13111400d67c25b5015e5bbdfd771116d9cc64c4db3724061130af82ecaee2817f39a2de6c85e4ffd6ef203
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
@@ -2,17 +2,15 @@
|
|
2
2
|
<!-- >>>>>> BEGIN GENERATED FILE (resolve): SOURCE readme_files/README.template.md -->
|
3
3
|
# MarkdownHelper
|
4
4
|
|
5
|
+
## What's This?
|
6
|
+
|
5
7
|
[![Gem Version](https://badge.fury.io/rb/markdown_helper.svg)](https://badge.fury.io/rb/markdown_helper)
|
6
8
|
|
7
9
|
Class <code>MarkdownHelper</code> supports:
|
8
10
|
|
9
11
|
* [File inclusion](#file-inclusion): to include text from other files, as code-block or markdown.
|
10
12
|
* [Image path resolution](#image-path-resolution): to resolve relative image paths to absolute URL paths (so they work even in gem documentation).
|
11
|
-
* [Image attributes](#image-
|
12
|
-
|
13
|
-
Next feature:
|
14
|
-
|
15
|
-
* "Slide deck": to chain markdown pages into a series with next/prev navigation links.
|
13
|
+
* [Image attributes](#image-attributes): image attributes are passed through to an HTML <code>img</code> tag.
|
16
14
|
|
17
15
|
## How It Works
|
18
16
|
|
@@ -20,6 +18,8 @@ The markdown helper reads a markdown document (template) and writes another mark
|
|
20
18
|
|
21
19
|
The template can contain certain instructions that call for file inclusions and image resolutions.
|
22
20
|
|
21
|
+
## Commented or Pristine?
|
22
|
+
|
23
23
|
By default, the output markdown has added comments that show:
|
24
24
|
|
25
25
|
* The path to the template file.
|
@@ -27,6 +27,7 @@ By default, the output markdown has added comments that show:
|
|
27
27
|
* The image description (original) for each resolved image file path.
|
28
28
|
|
29
29
|
You can suppress those comments using the <code>pristine</code> option.
|
30
|
+
|
30
31
|
## File Inclusion
|
31
32
|
|
32
33
|
<!-- >>>>>> BEGIN RESOLVED IMAGE: DESCRIPTION '![include_icon](images/include.png | width=50)
|
@@ -315,5 +316,16 @@ where:
|
|
315
316
|
```
|
316
317
|
<!-- <<<<<< END INCLUDED FILE (code_block): SOURCE readme_files/resolve.md -->
|
317
318
|
|
319
|
+
## What Should Be Next?
|
320
|
+
|
321
|
+
I have opened some enhancement Issues in the GitHub [MarkdownHelper](https://github.com/BurdetteLamar/MarkdownHelper) project:
|
322
|
+
|
323
|
+
* [Pagination](https://github.com/BurdetteLamar/MarkdownHelper/issues/40): series of markdown pages connected by prev/next navigation links.
|
324
|
+
* [Partial file inclusion](https://github.com/BurdetteLamar/MarkdownHelper/issues/38): including only specified lines from a file (instead of the whole file).
|
325
|
+
* [Ruby-entity inclusion](https://github.com/BurdetteLamar/MarkdownHelper/issues/39): like file inclusion, but including a Ruby class, module, or method.
|
326
|
+
* [File TOC](https://github.com/BurdetteLamar/MarkdownHelper/issues/36): table of contents of all headers in a markdown page.
|
327
|
+
* [Project TOC](https://github.com/BurdetteLamar/MarkdownHelper/issues/37): table of contents of all markdown pages in project.
|
328
|
+
|
329
|
+
Feel free to comment on any of these, or to add more Issues (enhancement or otherwise).
|
318
330
|
<!-- <<<<<< END GENERATED FILE (resolve): SOURCE readme_files/README.template.md -->
|
319
331
|
<!-- <<<<<< END GENERATED FILE (include): SOURCE readme_files/temp_resolved.md -->
|
@@ -1,16 +1,14 @@
|
|
1
1
|
# MarkdownHelper
|
2
2
|
|
3
|
+
## What's This?
|
4
|
+
|
3
5
|
[![Gem Version](https://badge.fury.io/rb/markdown_helper.svg)](https://badge.fury.io/rb/markdown_helper)
|
4
6
|
|
5
7
|
Class <code>MarkdownHelper</code> supports:
|
6
8
|
|
7
9
|
* [File inclusion](#file-inclusion): to include text from other files, as code-block or markdown.
|
8
10
|
* [Image path resolution](#image-path-resolution): to resolve relative image paths to absolute URL paths (so they work even in gem documentation).
|
9
|
-
* [Image attributes](#image-
|
10
|
-
|
11
|
-
Next feature:
|
12
|
-
|
13
|
-
* "Slide deck": to chain markdown pages into a series with next/prev navigation links.
|
11
|
+
* [Image attributes](#image-attributes): image attributes are passed through to an HTML <code>img</code> tag.
|
14
12
|
|
15
13
|
## How It Works
|
16
14
|
|
@@ -18,6 +16,8 @@ The markdown helper reads a markdown document (template) and writes another mark
|
|
18
16
|
|
19
17
|
The template can contain certain instructions that call for file inclusions and image resolutions.
|
20
18
|
|
19
|
+
## Commented or Pristine?
|
20
|
+
|
21
21
|
By default, the output markdown has added comments that show:
|
22
22
|
|
23
23
|
* The path to the template file.
|
@@ -25,6 +25,7 @@ By default, the output markdown has added comments that show:
|
|
25
25
|
* The image description (original) for each resolved image file path.
|
26
26
|
|
27
27
|
You can suppress those comments using the <code>pristine</code> option.
|
28
|
+
|
28
29
|
## File Inclusion
|
29
30
|
|
30
31
|
![include_icon](images/include.png | width=50)
|
@@ -157,3 +158,14 @@ where:
|
|
157
158
|
|
158
159
|
@[code_block](resolve.md)
|
159
160
|
|
161
|
+
## What Should Be Next?
|
162
|
+
|
163
|
+
I have opened some enhancement Issues in the GitHub [MarkdownHelper](https://github.com/BurdetteLamar/MarkdownHelper) project:
|
164
|
+
|
165
|
+
* [Pagination](https://github.com/BurdetteLamar/MarkdownHelper/issues/40): series of markdown pages connected by prev/next navigation links.
|
166
|
+
* [Partial file inclusion](https://github.com/BurdetteLamar/MarkdownHelper/issues/38): including only specified lines from a file (instead of the whole file).
|
167
|
+
* [Ruby-entity inclusion](https://github.com/BurdetteLamar/MarkdownHelper/issues/39): like file inclusion, but including a Ruby class, module, or method.
|
168
|
+
* [File TOC](https://github.com/BurdetteLamar/MarkdownHelper/issues/36): table of contents of all headers in a markdown page.
|
169
|
+
* [Project TOC](https://github.com/BurdetteLamar/MarkdownHelper/issues/37): table of contents of all markdown pages in project.
|
170
|
+
|
171
|
+
Feel free to comment on any of these, or to add more Issues (enhancement or otherwise).
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: markdown_helper
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.2.
|
4
|
+
version: 0.2.4
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- burdettelamar
|
8
8
|
autorequire:
|
9
9
|
bindir: exe
|
10
10
|
cert_chain: []
|
11
|
-
date: 2018-03-
|
11
|
+
date: 2018-03-18 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: bundler
|