markdown_helper 1.9.5 → 1.9.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +15 -28
- data/Rakefile +1 -8
- data/lib/markdown_helper.rb +1 -0
- data/lib/markdown_helper/version.rb +1 -1
- data/markdown/readme/README.template.md +12 -7
- 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: 5e0a04d76854ae8481b445cf585ec71fd0758f13
|
4
|
+
data.tar.gz: 3f42eb714596c71add632f5cc7b131af9a343e36
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 860d4c5fdb2c862dbfcab19ac8bc397e286b838e2531e9457f1662d610b685e2ccc286cbc85a796a04e7bb51619978ed6be2dfd2f66fbe110ed46bcb268ec502
|
7
|
+
data.tar.gz: 32fbf0ed5a7dd3f0f0c3f6ab8c2d6d88d5e9a25f582a163d1a8dbde47d95d088fdfa4e146b39c04f4cba20ceb51f6480b191d653677aec50e332e0b4d5dbec4e
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
@@ -1,12 +1,12 @@
|
|
1
|
-
<!-- >>>>>> BEGIN GENERATED FILE (include): SOURCE
|
2
|
-
<!-- >>>>>> BEGIN GENERATED FILE (resolve): SOURCE README.template.md -->
|
1
|
+
<!-- >>>>>> BEGIN GENERATED FILE (include): SOURCE README.template.md -->
|
3
2
|
# Markdown Helper
|
4
3
|
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
4
|
+
 [Visit gem markdown_helper](https://rubygems.org/gems/markdown_helper)
|
5
|
+
|
6
|
+
## Deprecated
|
7
|
+
|
8
|
+
- Method ```:resolve```.
|
9
|
+
- Command ```markdown_helper resolve```.
|
10
10
|
|
11
11
|
## What's New?
|
12
12
|
|
@@ -22,8 +22,8 @@ Class <code>MarkdownHelper</code> supports:
|
|
22
22
|
|
23
23
|
* [File inclusion](#file-inclusion): to include text from other files, as code-block or markdown.
|
24
24
|
* [Page TOC](#page-toc): to create the table of contents for a markdown page.
|
25
|
-
* [Image path resolution](#image-path-resolution): to resolve relative image paths to absolute URL paths (so they work even in gem documentation).
|
26
|
-
* [Image attributes](#image-attributes): image attributes are passed through to an HTML <code>img</code> tag.
|
25
|
+
* [Image path resolution](#image-path-resolution): to resolve relative image paths to absolute URL paths (so they work even in gem documentation). [Deprecated]**
|
26
|
+
* [Image attributes](#image-attributes): image attributes are passed through to an HTML <code>img</code> tag. [Deprecated]**
|
27
27
|
|
28
28
|
## How It Works
|
29
29
|
|
@@ -41,17 +41,13 @@ By default, the output markdown has added comments that show:
|
|
41
41
|
|
42
42
|
* The path to the template file.
|
43
43
|
* The path to each included file.
|
44
|
-
* The image description (original) for each resolved image file path.
|
44
|
+
* The image description (original) for each resolved image file path. [Deprecated]**
|
45
45
|
|
46
46
|
You can suppress those comments using the <code>pristine</code> option.
|
47
47
|
|
48
48
|
## File Inclusion
|
49
49
|
|
50
|
-
|
51
|
-
' -->
|
52
|
-
<img src="https://raw.githubusercontent.com/BurdetteLamar/markdown_helper/master/images/include.png" alt="include_icon" width="50">
|
53
|
-
<!-- <<<<<< END RESOLVED IMAGES: INPUT-LINE '
|
54
|
-
' -->
|
50
|
+
<img src="images/include.png" alt="include_icon" width="50">
|
55
51
|
|
56
52
|
This markdown helper enables file inclusion in GitHub markdown.
|
57
53
|
|
@@ -180,13 +176,9 @@ The markdown helper can create the table of contents for a markdown page.
|
|
180
176
|
|
181
177
|
|
182
178
|
|
183
|
-
## Image Path Resolution
|
179
|
+
## Image Path Resolution **[Deprecated]**
|
184
180
|
|
185
|
-
|
186
|
-
' -->
|
187
|
-
<img src="https://raw.githubusercontent.com/BurdetteLamar/markdown_helper/master/images/image.png" alt="image_icon" width="50">
|
188
|
-
<!-- <<<<<< END RESOLVED IMAGES: INPUT-LINE '
|
189
|
-
' -->
|
181
|
+
<img src="images/image.png" alt="image_icon" width="50">
|
190
182
|
|
191
183
|
This markdown helper enables image path resolution in GitHub markdown.
|
192
184
|
|
@@ -267,11 +259,7 @@ where:
|
|
267
259
|
|
268
260
|
## Image Attributes
|
269
261
|
|
270
|
-
|
271
|
-
' -->
|
272
|
-
<img src="https://raw.githubusercontent.com/BurdetteLamar/markdown_helper/master/images/html.png" alt="html_icon" width="50">
|
273
|
-
<!-- <<<<<< END RESOLVED IMAGES: INPUT-LINE '
|
274
|
-
' -->
|
262
|
+
<img src="images/html.png" alt="html_icon" width="50">
|
275
263
|
|
276
264
|
This markdown helper enables HTML image attributes in GitHub markdown [image descriptions](https://github.github.com/gfm/#image-description).
|
277
265
|
|
@@ -358,5 +346,4 @@ I have opened some enhancement Issues in the GitHub [markdown_helper](https://gi
|
|
358
346
|
* [Pagination](https://github.com/BurdetteLamar/markdown_helper/issues/40): series of markdown pages connected by prev/next navigation links.
|
359
347
|
|
360
348
|
Feel free to comment on any of these, or to add more Issues (enhancement or otherwise).
|
361
|
-
<!-- <<<<<< END GENERATED FILE (
|
362
|
-
<!-- <<<<<< END GENERATED FILE (include): SOURCE temp_resolved.md -->
|
349
|
+
<!-- <<<<<< END GENERATED FILE (include): SOURCE README.template.md -->
|
data/Rakefile
CHANGED
@@ -19,14 +19,7 @@ namespace :build do
|
|
19
19
|
template_file_path = 'highlight_ruby_template.md'
|
20
20
|
markdown_file_path = 'highlighted_ruby.md'
|
21
21
|
markdown_helper.include(template_file_path, markdown_file_path)
|
22
|
-
|
23
|
-
# This protects example code from being also resolved, thus damaging the example code.
|
24
|
-
# Temp file must be in the same directory as its source (it becomes the source).
|
25
|
-
temp_file_path = 'temp_resolved.md'
|
26
|
-
markdown_helper.resolve('README.template.md', temp_file_path)
|
27
|
-
readme_file_path = '../../README.md'
|
28
|
-
markdown_helper.include(temp_file_path, readme_file_path)
|
29
|
-
File.delete(temp_file_path)
|
22
|
+
markdown_helper.include('README.template.md', '../../README.md')
|
30
23
|
end
|
31
24
|
end
|
32
25
|
|
data/lib/markdown_helper.rb
CHANGED
@@ -84,6 +84,7 @@ class MarkdownHelper
|
|
84
84
|
# )
|
85
85
|
def resolve(template_file_path, markdown_file_path)
|
86
86
|
# Method :generate_file does the first things, yields the block, does the last things.
|
87
|
+
warn("Method :resolve is deprecated")
|
87
88
|
send(:generate_file, template_file_path, markdown_file_path, __method__) do |input_lines, output_lines|
|
88
89
|
send(:resolve_images, template_file_path, input_lines, output_lines)
|
89
90
|
end
|
@@ -2,6 +2,11 @@
|
|
2
2
|
|
3
3
|
 [Visit gem markdown_helper](https://rubygems.org/gems/markdown_helper)
|
4
4
|
|
5
|
+
## Deprecated
|
6
|
+
|
7
|
+
- Method ```:resolve```.
|
8
|
+
- Command ```markdown_helper resolve```.
|
9
|
+
|
5
10
|
## What's New?
|
6
11
|
|
7
12
|
Page TOC:
|
@@ -16,8 +21,8 @@ Class <code>MarkdownHelper</code> supports:
|
|
16
21
|
|
17
22
|
* [File inclusion](#file-inclusion): to include text from other files, as code-block or markdown.
|
18
23
|
* [Page TOC](#page-toc): to create the table of contents for a markdown page.
|
19
|
-
* [Image path resolution](#image-path-resolution): to resolve relative image paths to absolute URL paths (so they work even in gem documentation).
|
20
|
-
* [Image attributes](#image-attributes): image attributes are passed through to an HTML <code>img</code> tag.
|
24
|
+
* [Image path resolution](#image-path-resolution): to resolve relative image paths to absolute URL paths (so they work even in gem documentation). [Deprecated]**
|
25
|
+
* [Image attributes](#image-attributes): image attributes are passed through to an HTML <code>img</code> tag. [Deprecated]**
|
21
26
|
|
22
27
|
## How It Works
|
23
28
|
|
@@ -35,13 +40,13 @@ By default, the output markdown has added comments that show:
|
|
35
40
|
|
36
41
|
* The path to the template file.
|
37
42
|
* The path to each included file.
|
38
|
-
* The image description (original) for each resolved image file path.
|
43
|
+
* The image description (original) for each resolved image file path. [Deprecated]**
|
39
44
|
|
40
45
|
You can suppress those comments using the <code>pristine</code> option.
|
41
46
|
|
42
47
|
## File Inclusion
|
43
48
|
|
44
|
-
|
49
|
+
<img src="images/include.png" alt="include_icon" width="50">
|
45
50
|
|
46
51
|
This markdown helper enables file inclusion in GitHub markdown.
|
47
52
|
|
@@ -109,9 +114,9 @@ The markdown helper can create the table of contents for a markdown page.
|
|
109
114
|
|
110
115
|
|
111
116
|
|
112
|
-
## Image Path Resolution
|
117
|
+
## Image Path Resolution **[Deprecated]**
|
113
118
|
|
114
|
-
|
119
|
+
<img src="images/image.png" alt="image_icon" width="50">
|
115
120
|
|
116
121
|
This markdown helper enables image path resolution in GitHub markdown.
|
117
122
|
|
@@ -149,7 +154,7 @@ where:
|
|
149
154
|
|
150
155
|
## Image Attributes
|
151
156
|
|
152
|
-
|
157
|
+
<img src="images/html.png" alt="html_icon" width="50">
|
153
158
|
|
154
159
|
This markdown helper enables HTML image attributes in GitHub markdown [image descriptions](https://github.github.com/gfm/#image-description).
|
155
160
|
|
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: 1.9.
|
4
|
+
version: 1.9.9
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- burdettelamar
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2018-06-
|
11
|
+
date: 2018-06-04 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: bundler
|