markdown_helper 2.0.0 → 2.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/Gemfile.lock +1 -1
- data/README.md +74 -208
- data/Rakefile +0 -1
- data/lib/markdown_helper.rb +115 -248
- data/lib/markdown_helper/version.rb +1 -1
- data/markdown/readme/README.template.md +43 -101
- data/markdown/readme/include.md +4 -0
- data/markdown/readme/include_usage.rb +1 -2
- data/markdown/use_cases/Rakefile +28 -31
- data/markdown/use_cases/include_files/diagnose_circular_includes/diagnose_circular_includes.err +1 -1
- data/markdown/use_cases/include_files/diagnose_circular_includes/use_case.md +1 -1
- data/markdown/use_cases/include_files/diagnose_circular_includes/{diagnose_circular_includes.rb → use_case_builder.rb} +1 -2
- data/markdown/use_cases/include_files/diagnose_missing_includee/diagnose_missing_includee.err +1 -1
- data/markdown/use_cases/include_files/diagnose_missing_includee/use_case.md +1 -1
- data/markdown/use_cases/include_files/diagnose_missing_includee/{diagnose_missing_includee.rb → use_case_builder.rb} +1 -2
- data/markdown/use_cases/include_files/include_code_block/{include_code_block.rb → use_case_builder.rb} +1 -2
- data/markdown/use_cases/include_files/include_generated_text/{include_generated_text.rb → use_case_builder.rb} +1 -2
- data/markdown/use_cases/include_files/include_highlighted_code/{include_highlighted_code.rb → use_case_builder.rb} +1 -2
- data/markdown/use_cases/include_files/include_markdown/{include_markdown.rb → use_case_builder.rb} +1 -2
- data/markdown/use_cases/include_files/include_page_toc/included.md +48 -0
- data/markdown/use_cases/include_files/include_page_toc/includer.md +16 -0
- data/markdown/use_cases/include_files/include_page_toc/markdown_0.md +8 -0
- data/markdown/use_cases/include_files/include_page_toc/markdown_1.md +8 -0
- data/markdown/use_cases/include_files/include_page_toc/use_case.md +212 -0
- data/markdown/use_cases/include_files/include_page_toc/use_case_builder.rb +121 -0
- data/markdown/use_cases/include_files/include_page_toc/use_case_template.md +46 -0
- data/markdown/use_cases/include_files/include_text_as_comment/{include_text_as_comment.rb → use_case_builder.rb} +1 -2
- data/markdown/use_cases/include_files/include_text_as_pre/{include_text_as_pre.rb → use_case_builder.rb} +1 -2
- data/markdown/use_cases/include_files/include_use_case.rb +2 -8
- data/markdown/use_cases/include_files/include_with_added_comments/{include_with_added_comments.rb → use_case_builder.rb} +2 -3
- data/markdown/use_cases/include_files/nest_inclusions/{nest_inclusions.rb → use_case_builder.rb} +1 -2
- data/markdown/use_cases/include_files/reuse_text/{reuse_text.rb → use_case_builder.rb} +3 -2
- data/markdown/use_cases/structure.md +10 -0
- data/markdown/use_cases/tables_of_contents/create_and_include_page_toc/included.md +44 -0
- data/markdown/use_cases/tables_of_contents/create_and_include_page_toc/page.md +7 -7
- data/markdown/use_cases/tables_of_contents/create_and_include_page_toc/toc.md +7 -7
- data/markdown/use_cases/tables_of_contents/create_and_include_page_toc/{create_and_include_page_toc.rb → use_case_builder.rb} +1 -2
- data/markdown/use_cases/tables_of_contents/create_page_toc_use_case.rb +1 -1
- data/markdown/use_cases/use_case.rb +14 -15
- data/markdown/use_cases/use_cases.md +2 -4
- data/markdown_helper.gemspec +0 -2
- metadata +24 -29
- data/bin/_resolve +0 -46
- data/bin/resolve +0 -49
- data/bin/usage/resolve.txt +0 -14
- data/images/html.png +0 -0
- data/markdown/readme/resolve_usage.rb +0 -12
- data/markdown/use_cases/include_files/diagnose_missing_includee/included.md +0 -1
- data/markdown/use_cases/resolve/gemify_images/gemify_images.md +0 -11
- data/markdown/use_cases/resolve/gemify_images/gemify_images.rb +0 -68
- data/markdown/use_cases/resolve/gemify_images/relative_image.md +0 -1
- data/markdown/use_cases/resolve/gemify_images/resolved_image.md +0 -1
- data/markdown/use_cases/resolve/gemify_images/template.md +0 -15
- data/markdown/use_cases/resolve/resize_images/template.md +0 -8
|
@@ -4,11 +4,10 @@ class IncludeWithAddedComments < IncludeUseCase
|
|
|
4
4
|
|
|
5
5
|
def self.build
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
use_case = self.new(use_case_name)
|
|
7
|
+
use_case = self.new
|
|
9
8
|
|
|
10
9
|
include_command = IncludeUseCase.construct_include_command(INCLUDER_FILE_NAME, INCLUDED_FILE_NAME, pristine = false)
|
|
11
|
-
use_case.commands_to_execute.
|
|
10
|
+
use_case.commands_to_execute.unshift(include_command)
|
|
12
11
|
|
|
13
12
|
use_case.files_to_write.store(
|
|
14
13
|
TEMPLATE_FILE_NAME,
|
|
@@ -4,13 +4,14 @@ class ReuseText < IncludeUseCase
|
|
|
4
4
|
|
|
5
5
|
def self.build
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
use_case = self.new(use_case_name)
|
|
7
|
+
use_case = self.new
|
|
9
8
|
|
|
10
9
|
use_case.write_includee_file
|
|
11
10
|
use_case.write_includer_file
|
|
12
11
|
use_case.write_ruby_file(pristine = true)
|
|
13
12
|
|
|
13
|
+
use_case.commands_to_execute.push('ruby include.rb')
|
|
14
|
+
|
|
14
15
|
File.write(
|
|
15
16
|
TEMPLATE_FILE_NAME,
|
|
16
17
|
<<EOT
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Use Case Code Structure
|
|
2
|
+
|
|
3
|
+
Each immediate subdirectory here represents a markdown-helper function that is available in both the API and the CLI.
|
|
4
|
+
|
|
5
|
+
Each diretory therein represents a single se case, and must have:
|
|
6
|
+
|
|
7
|
+
- A conventionally-named Ruby file that will be executed to build the use case. The file name is "#{dir_name}.rb".
|
|
8
|
+
- A conventionally-named markdown template named ```use_case_template.md```.
|
|
9
|
+
|
|
10
|
+
The executed Ruby file must create all other files that are required for ths use case.
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
<!-- >>>>>> BEGIN GENERATED FILE (include): SOURCE includer.md -->
|
|
2
|
+
### Page Contents
|
|
3
|
+
|
|
4
|
+
<!-- >>>>>> BEGIN INCLUDED FILE (markdown): SOURCE markdown/use_cases/tables_of_contents/create_and_include_page_toc/toc.md -->
|
|
5
|
+
- [Lorem Ipsum](#lorem-ipsum)
|
|
6
|
+
- [Curabitur Tortor](#curabitur-tortor)
|
|
7
|
+
- [Quisque Volutpat](#quisque-volutpat)
|
|
8
|
+
- [Sed Lectus](#sed-lectus)
|
|
9
|
+
- [Curabitur Sit](#curabitur-sit)
|
|
10
|
+
- [Vestibulum Nisi](#vestibulum-nisi)
|
|
11
|
+
- [Sed Cursus](#sed-cursus)
|
|
12
|
+
<!-- <<<<<< END INCLUDED FILE (markdown): SOURCE markdown/use_cases/tables_of_contents/create_and_include_page_toc/toc.md -->
|
|
13
|
+
|
|
14
|
+
<!-- >>>>>> BEGIN INCLUDED FILE (markdown): SOURCE markdown/use_cases/tables_of_contents/create_and_include_page_toc/text.md -->
|
|
15
|
+
# Lorem Ipsum
|
|
16
|
+
|
|
17
|
+
Dolor sit amet, consectetur adipiscing elit. Integer nec odio. Praesent libero. Sed cursus ante dapibus diam. Sed nisi. Nulla quis sem at nibh elementum imperdiet. Duis sagittis ipsum. Praesent mauris. Fusce nec tellus sed augue semper porta. Mauris massa. Vestibulum lacinia arcu eget nulla. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Curabitur sodales ligula in libero. Sed dignissim lacinia nunc.
|
|
18
|
+
|
|
19
|
+
## Curabitur Tortor
|
|
20
|
+
|
|
21
|
+
Pellentesque nibh. Aenean quam. In scelerisque sem at dolor. Maecenas mattis. Sed convallis tristique sem. Proin ut ligula vel nunc egestas porttitor. Morbi lectus risus, iaculis vel, suscipit quis, luctus non, massa. Fusce ac turpis quis ligula lacinia aliquet. Mauris ipsum. Nulla metus metus, ullamcorper vel, tincidunt sed, euismod in, nibh.
|
|
22
|
+
|
|
23
|
+
### Quisque Volutpat
|
|
24
|
+
|
|
25
|
+
Cndimentum velit. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Nam nec ante. Sed lacinia, urna non tincidunt mattis, tortor neque adipiscing diam, a cursus ipsum ante quis turpis. Nulla facilisi. Ut fringilla. Suspendisse potenti. Nunc feugiat mi a tellus consequat imperdiet. Vestibulum sapien. Proin quam. Etiam ultrices. Suspendisse in justo eu magna luctus suscipit.
|
|
26
|
+
|
|
27
|
+
### Sed Lectus
|
|
28
|
+
|
|
29
|
+
Integer euismod lacus luctus magna. Quisque cursus, metus vitae pharetra auctor, sem massa mattis sem, at interdum magna augue eget diam. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Morbi lacinia molestie dui. Praesent blandit dolor. Sed non quam. In vel mi sit amet augue congue elementum. Morbi in ipsum sit amet pede facilisis laoreet. Donec lacus nunc, viverra nec, blandit vel, egestas et, augue. Vestibulum tincidunt malesuada tellus. Ut ultrices ultrices enim.
|
|
30
|
+
|
|
31
|
+
## Curabitur Sit
|
|
32
|
+
|
|
33
|
+
Amet mauris. Morbi in dui quis est pulvinar ullamcorper. Nulla facilisi. Integer lacinia sollicitudin massa. Cras metus. Sed aliquet risus a tortor. Integer id quam. Morbi mi. Quisque nisl felis, venenatis tristique, dignissim in, ultrices sit amet, augue. Proin sodales libero eget ante. Nulla quam. Aenean laoreet.
|
|
34
|
+
|
|
35
|
+
### Vestibulum Nisi
|
|
36
|
+
|
|
37
|
+
Lectus, commodo ac, facilisis ac, ultricies eu, pede. Ut orci risus, accumsan porttitor, cursus quis, aliquet eget, justo. Sed pretium blandit orci. Ut eu diam at pede suscipit sodales. Aenean lectus elit, fermentum non, convallis id, sagittis at, neque. Nullam mauris orci, aliquet et, iaculis et, viverra vitae, ligula. Nulla ut felis in purus aliquam imperdiet. Maecenas aliquet mollis lectus. Vivamus consectetuer risus et tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer nec odio. Praesent libero.
|
|
38
|
+
|
|
39
|
+
### Sed Cursus
|
|
40
|
+
|
|
41
|
+
Ante dapibus diam. Sed nisi. Nulla quis sem at nibh elementum imperdiet. Duis sagittis ipsum. Praesent mauris. Fusce nec tellus sed augue semper porta. Mauris massa. Vestibulum lacinia arcu eget nulla. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Curabitur sodales ligula in libero. Sed dignissim lacinia nunc.
|
|
42
|
+
|
|
43
|
+
<!-- <<<<<< END INCLUDED FILE (markdown): SOURCE markdown/use_cases/tables_of_contents/create_and_include_page_toc/text.md -->
|
|
44
|
+
<!-- <<<<<< END GENERATED FILE (include): SOURCE includer.md -->
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
### Page Contents
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
3
|
+
- [Lorem Ipsum](#lorem-ipsum)
|
|
4
|
+
- [Curabitur Tortor](#curabitur-tortor)
|
|
5
|
+
- [Quisque Volutpat](#quisque-volutpat)
|
|
6
|
+
- [Sed Lectus](#sed-lectus)
|
|
7
|
+
- [Curabitur Sit](#curabitur-sit)
|
|
8
|
+
- [Vestibulum Nisi](#vestibulum-nisi)
|
|
9
|
+
- [Sed Cursus](#sed-cursus)
|
|
10
10
|
|
|
11
11
|
# Lorem Ipsum
|
|
12
12
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
1
|
+
- [Lorem Ipsum](#lorem-ipsum)
|
|
2
|
+
- [Curabitur Tortor](#curabitur-tortor)
|
|
3
|
+
- [Quisque Volutpat](#quisque-volutpat)
|
|
4
|
+
- [Sed Lectus](#sed-lectus)
|
|
5
|
+
- [Curabitur Sit](#curabitur-sit)
|
|
6
|
+
- [Vestibulum Nisi](#vestibulum-nisi)
|
|
7
|
+
- [Sed Cursus](#sed-cursus)
|
|
@@ -1,27 +1,30 @@
|
|
|
1
1
|
class UseCase
|
|
2
2
|
|
|
3
|
-
attr_accessor :
|
|
3
|
+
attr_accessor :files_to_write, :commands_to_execute
|
|
4
4
|
|
|
5
5
|
USE_CASE_FILE_NAME = 'use_case.md'
|
|
6
6
|
TEMPLATE_FILE_NAME = 'use_case_template.md'
|
|
7
|
+
BUILDER_FILE_NAME = 'use_case_builder.rb'
|
|
7
8
|
|
|
8
|
-
def initialize
|
|
9
|
-
self.use_case_dir_path = use_case_dir_path
|
|
9
|
+
def initialize
|
|
10
10
|
self.files_to_write = {}
|
|
11
11
|
self.commands_to_execute = []
|
|
12
12
|
end
|
|
13
13
|
|
|
14
14
|
def build
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
end
|
|
20
|
-
end
|
|
21
|
-
commands_to_execute.each do |command|
|
|
22
|
-
system(command)
|
|
15
|
+
|
|
16
|
+
files_to_write.each_pair do |file_name, text|
|
|
17
|
+
File.open(file_name, 'w') do |file|
|
|
18
|
+
file.write(text)
|
|
23
19
|
end
|
|
24
20
|
end
|
|
21
|
+
if File.exist?('includer.md')
|
|
22
|
+
command = self.construct_include_command('includer.md','included.md', pristine = true)
|
|
23
|
+
system(command)
|
|
24
|
+
end
|
|
25
|
+
commands_to_execute.each do |command|
|
|
26
|
+
system(command)
|
|
27
|
+
end
|
|
25
28
|
end
|
|
26
29
|
|
|
27
30
|
def construct_command(command, template_file_path, markdown_file_path, pristine = false)
|
|
@@ -33,10 +36,6 @@ class UseCase
|
|
|
33
36
|
construct_command(:include, template_file_path, markdown_file_path, pristine)
|
|
34
37
|
end
|
|
35
38
|
|
|
36
|
-
def construct_resolve_command(template_file_path, markdown_file_path, pristine = false)
|
|
37
|
-
construct_command(:resolve, template_file_path, markdown_file_path, pristine)
|
|
38
|
-
end
|
|
39
|
-
|
|
40
39
|
def UseCase.construct_include_command(template_file_path, markdown_file_path, pristine = false)
|
|
41
40
|
pristine_option = pristine ? '--pristine ' : ''
|
|
42
41
|
"markdown_helper include #{pristine_option}#{template_file_path} #{markdown_file_path}"
|
|
@@ -3,16 +3,14 @@
|
|
|
3
3
|
## Include Files
|
|
4
4
|
|
|
5
5
|
* [Reuse Text](include_files/reuse_text/use_case.md#reuse-text)
|
|
6
|
-
* [Include with Added Comments](include_files/include_with_added_comments/use_case.md#include-with-added-comments)
|
|
7
6
|
* [Nest Inclusions](include_files/nest_inclusions/use_case.md#nest-inclusions)
|
|
8
7
|
* [Include Markdown](include_files/include_markdown/use_case.md#include-markdown)
|
|
9
8
|
* [Include Code Block](include_files/include_code_block/use_case.md#include-code-block)
|
|
10
9
|
* [Include Highlighted Code](include_files/include_highlighted_code/use_case.md#include-highlighted-code)
|
|
10
|
+
* [Include Page TOC](include_files/include_page_toc/use_case.md#include-page-toc)
|
|
11
11
|
* [Include Text As Comment](include_files/include_text_as_comment/use_case.md#include-text-as-comment)
|
|
12
12
|
* [Include Text As Pre](include_files/include_text_as_pre/use_case.md#include-text-as-pre)
|
|
13
13
|
* [Include Generated Text](include_files/include_generated_text/use_case.md#include-generated-text)
|
|
14
|
+
* [Include with Added Comments](include_files/include_with_added_comments/use_case.md#include-with-added-comments)
|
|
14
15
|
* [Diagnose Missing Includee](include_files/diagnose_missing_includee/use_case.md#diagnose-missing-includee)
|
|
15
16
|
* [Diagnose Circular Includes](include_files/diagnose_circular_includes/use_case.md#diagnose-circular-includes)
|
|
16
|
-
## Tables of Contents
|
|
17
|
-
|
|
18
|
-
* [Create and Include Page TOC](tables_of_contents/create_and_include_page_toc/use_case.md#create-and-include-page-toc)
|
data/markdown_helper.gemspec
CHANGED
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: 2.
|
|
4
|
+
version: 2.1.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- burdettelamar
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2018-
|
|
11
|
+
date: 2018-12-03 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: bundler
|
|
@@ -71,8 +71,6 @@ description: |
|
|
|
71
71
|
|
|
72
72
|
* File inclusion
|
|
73
73
|
* Page TOC
|
|
74
|
-
* Image path resolution
|
|
75
|
-
* Image attributes
|
|
76
74
|
email:
|
|
77
75
|
- burdettelamar@yahoo.com
|
|
78
76
|
executables:
|
|
@@ -92,16 +90,12 @@ files:
|
|
|
92
90
|
- _config.yml
|
|
93
91
|
- bin/_create_page_toc
|
|
94
92
|
- bin/_include
|
|
95
|
-
- bin/_resolve
|
|
96
93
|
- bin/console
|
|
97
94
|
- bin/include
|
|
98
95
|
- bin/markdown_helper
|
|
99
|
-
- bin/resolve
|
|
100
96
|
- bin/setup
|
|
101
97
|
- bin/usage/create_page_toc.txt
|
|
102
98
|
- bin/usage/include.txt
|
|
103
|
-
- bin/usage/resolve.txt
|
|
104
|
-
- images/html.png
|
|
105
99
|
- images/image.png
|
|
106
100
|
- images/include.png
|
|
107
101
|
- lib/markdown_helper.rb
|
|
@@ -115,99 +109,100 @@ files:
|
|
|
115
109
|
- markdown/readme/include.rb
|
|
116
110
|
- markdown/readme/include_usage.rb
|
|
117
111
|
- markdown/readme/resolve.md
|
|
118
|
-
- markdown/readme/resolve_usage.rb
|
|
119
112
|
- markdown/readme/verbatim_ruby_template.md
|
|
120
113
|
- markdown/use_cases/Rakefile
|
|
121
114
|
- markdown/use_cases/include_files/diagnose_circular_includes/diagnose_circular_includes.err
|
|
122
|
-
- markdown/use_cases/include_files/diagnose_circular_includes/diagnose_circular_includes.rb
|
|
123
115
|
- markdown/use_cases/include_files/diagnose_circular_includes/include.rb
|
|
124
116
|
- markdown/use_cases/include_files/diagnose_circular_includes/includer.md
|
|
125
117
|
- markdown/use_cases/include_files/diagnose_circular_includes/includer_0.md
|
|
126
118
|
- markdown/use_cases/include_files/diagnose_circular_includes/includer_1.md
|
|
127
119
|
- markdown/use_cases/include_files/diagnose_circular_includes/includer_2.md
|
|
128
120
|
- markdown/use_cases/include_files/diagnose_circular_includes/use_case.md
|
|
121
|
+
- markdown/use_cases/include_files/diagnose_circular_includes/use_case_builder.rb
|
|
129
122
|
- markdown/use_cases/include_files/diagnose_circular_includes/use_case_template.md
|
|
130
123
|
- markdown/use_cases/include_files/diagnose_missing_includee/diagnose_missing_includee.err
|
|
131
|
-
- markdown/use_cases/include_files/diagnose_missing_includee/diagnose_missing_includee.rb
|
|
132
124
|
- markdown/use_cases/include_files/diagnose_missing_includee/include.rb
|
|
133
|
-
- markdown/use_cases/include_files/diagnose_missing_includee/included.md
|
|
134
125
|
- markdown/use_cases/include_files/diagnose_missing_includee/includer.md
|
|
135
126
|
- markdown/use_cases/include_files/diagnose_missing_includee/includer_0.md
|
|
136
127
|
- markdown/use_cases/include_files/diagnose_missing_includee/includer_1.md
|
|
137
128
|
- markdown/use_cases/include_files/diagnose_missing_includee/includer_2.md
|
|
138
129
|
- markdown/use_cases/include_files/diagnose_missing_includee/use_case.md
|
|
130
|
+
- markdown/use_cases/include_files/diagnose_missing_includee/use_case_builder.rb
|
|
139
131
|
- markdown/use_cases/include_files/diagnose_missing_includee/use_case_template.md
|
|
140
132
|
- markdown/use_cases/include_files/include.rb
|
|
141
133
|
- markdown/use_cases/include_files/include_code_block/hello.rb
|
|
142
|
-
- markdown/use_cases/include_files/include_code_block/include_code_block.rb
|
|
143
134
|
- markdown/use_cases/include_files/include_code_block/included.md
|
|
144
135
|
- markdown/use_cases/include_files/include_code_block/includer.md
|
|
145
136
|
- markdown/use_cases/include_files/include_code_block/use_case.md
|
|
137
|
+
- markdown/use_cases/include_files/include_code_block/use_case_builder.rb
|
|
146
138
|
- markdown/use_cases/include_files/include_code_block/use_case_template.md
|
|
147
|
-
- markdown/use_cases/include_files/include_generated_text/include_generated_text.rb
|
|
148
139
|
- markdown/use_cases/include_files/include_generated_text/use_case.md
|
|
140
|
+
- markdown/use_cases/include_files/include_generated_text/use_case_builder.rb
|
|
149
141
|
- markdown/use_cases/include_files/include_generated_text/use_case_template.md
|
|
150
142
|
- markdown/use_cases/include_files/include_highlighted_code/hello.rb
|
|
151
|
-
- markdown/use_cases/include_files/include_highlighted_code/include_highlighted_code.rb
|
|
152
143
|
- markdown/use_cases/include_files/include_highlighted_code/included.md
|
|
153
144
|
- markdown/use_cases/include_files/include_highlighted_code/includer.md
|
|
154
145
|
- markdown/use_cases/include_files/include_highlighted_code/use_case.md
|
|
146
|
+
- markdown/use_cases/include_files/include_highlighted_code/use_case_builder.rb
|
|
155
147
|
- markdown/use_cases/include_files/include_highlighted_code/use_case_template.md
|
|
156
|
-
- markdown/use_cases/include_files/include_markdown/include_markdown.rb
|
|
157
148
|
- markdown/use_cases/include_files/include_markdown/included.md
|
|
158
149
|
- markdown/use_cases/include_files/include_markdown/includer.md
|
|
159
150
|
- markdown/use_cases/include_files/include_markdown/markdown.md
|
|
160
151
|
- markdown/use_cases/include_files/include_markdown/use_case.md
|
|
152
|
+
- markdown/use_cases/include_files/include_markdown/use_case_builder.rb
|
|
161
153
|
- markdown/use_cases/include_files/include_markdown/use_case_template.md
|
|
154
|
+
- markdown/use_cases/include_files/include_page_toc/included.md
|
|
155
|
+
- markdown/use_cases/include_files/include_page_toc/includer.md
|
|
156
|
+
- markdown/use_cases/include_files/include_page_toc/markdown_0.md
|
|
157
|
+
- markdown/use_cases/include_files/include_page_toc/markdown_1.md
|
|
158
|
+
- markdown/use_cases/include_files/include_page_toc/use_case.md
|
|
159
|
+
- markdown/use_cases/include_files/include_page_toc/use_case_builder.rb
|
|
160
|
+
- markdown/use_cases/include_files/include_page_toc/use_case_template.md
|
|
162
161
|
- markdown/use_cases/include_files/include_text_as_comment/hello.rb
|
|
163
|
-
- markdown/use_cases/include_files/include_text_as_comment/include_text_as_comment.rb
|
|
164
162
|
- markdown/use_cases/include_files/include_text_as_comment/included.md
|
|
165
163
|
- markdown/use_cases/include_files/include_text_as_comment/includer.md
|
|
166
164
|
- markdown/use_cases/include_files/include_text_as_comment/use_case.md
|
|
165
|
+
- markdown/use_cases/include_files/include_text_as_comment/use_case_builder.rb
|
|
167
166
|
- markdown/use_cases/include_files/include_text_as_comment/use_case_template.md
|
|
168
|
-
- markdown/use_cases/include_files/include_text_as_pre/include_text_as_pre.rb
|
|
169
167
|
- markdown/use_cases/include_files/include_text_as_pre/included.md
|
|
170
168
|
- markdown/use_cases/include_files/include_text_as_pre/includer.md
|
|
171
169
|
- markdown/use_cases/include_files/include_text_as_pre/triple_backtick.md
|
|
172
170
|
- markdown/use_cases/include_files/include_text_as_pre/use_case.md
|
|
171
|
+
- markdown/use_cases/include_files/include_text_as_pre/use_case_builder.rb
|
|
173
172
|
- markdown/use_cases/include_files/include_text_as_pre/use_case_template.md
|
|
174
173
|
- markdown/use_cases/include_files/include_use_case.rb
|
|
175
|
-
- markdown/use_cases/include_files/include_with_added_comments/include_with_added_comments.rb
|
|
176
174
|
- markdown/use_cases/include_files/include_with_added_comments/included.md
|
|
177
175
|
- markdown/use_cases/include_files/include_with_added_comments/includee.md
|
|
178
176
|
- markdown/use_cases/include_files/include_with_added_comments/includer.md
|
|
179
177
|
- markdown/use_cases/include_files/include_with_added_comments/use_case.md
|
|
178
|
+
- markdown/use_cases/include_files/include_with_added_comments/use_case_builder.rb
|
|
180
179
|
- markdown/use_cases/include_files/include_with_added_comments/use_case_template.md
|
|
181
180
|
- markdown/use_cases/include_files/interface.md
|
|
182
181
|
- markdown/use_cases/include_files/nest_inclusions/included.md
|
|
183
182
|
- markdown/use_cases/include_files/nest_inclusions/includee.md
|
|
184
183
|
- markdown/use_cases/include_files/nest_inclusions/includer.md
|
|
185
|
-
- markdown/use_cases/include_files/nest_inclusions/nest_inclusions.rb
|
|
186
184
|
- markdown/use_cases/include_files/nest_inclusions/nested_includee.md
|
|
187
185
|
- markdown/use_cases/include_files/nest_inclusions/use_case.md
|
|
186
|
+
- markdown/use_cases/include_files/nest_inclusions/use_case_builder.rb
|
|
188
187
|
- markdown/use_cases/include_files/nest_inclusions/use_case_template.md
|
|
189
188
|
- markdown/use_cases/include_files/reuse_text/include.rb
|
|
190
189
|
- markdown/use_cases/include_files/reuse_text/included.md
|
|
191
190
|
- markdown/use_cases/include_files/reuse_text/includee.md
|
|
192
191
|
- markdown/use_cases/include_files/reuse_text/includer.md
|
|
193
|
-
- markdown/use_cases/include_files/reuse_text/reuse_text.rb
|
|
194
192
|
- markdown/use_cases/include_files/reuse_text/use_case.md
|
|
193
|
+
- markdown/use_cases/include_files/reuse_text/use_case_builder.rb
|
|
195
194
|
- markdown/use_cases/include_files/reuse_text/use_case_template.md
|
|
196
195
|
- markdown/use_cases/pristine.md
|
|
197
|
-
- markdown/use_cases/
|
|
198
|
-
- markdown/use_cases/resolve/gemify_images/gemify_images.rb
|
|
199
|
-
- markdown/use_cases/resolve/gemify_images/relative_image.md
|
|
200
|
-
- markdown/use_cases/resolve/gemify_images/resolved_image.md
|
|
201
|
-
- markdown/use_cases/resolve/gemify_images/template.md
|
|
202
|
-
- markdown/use_cases/resolve/resize_images/template.md
|
|
196
|
+
- markdown/use_cases/structure.md
|
|
203
197
|
- markdown/use_cases/tables_of_contents/create_and_include_page_toc/create_and_include.rb
|
|
204
198
|
- markdown/use_cases/tables_of_contents/create_and_include_page_toc/create_and_include.sh
|
|
205
|
-
- markdown/use_cases/tables_of_contents/create_and_include_page_toc/
|
|
199
|
+
- markdown/use_cases/tables_of_contents/create_and_include_page_toc/included.md
|
|
206
200
|
- markdown/use_cases/tables_of_contents/create_and_include_page_toc/includer.md
|
|
207
201
|
- markdown/use_cases/tables_of_contents/create_and_include_page_toc/page.md
|
|
208
202
|
- markdown/use_cases/tables_of_contents/create_and_include_page_toc/text.md
|
|
209
203
|
- markdown/use_cases/tables_of_contents/create_and_include_page_toc/toc.md
|
|
210
204
|
- markdown/use_cases/tables_of_contents/create_and_include_page_toc/use_case.md
|
|
205
|
+
- markdown/use_cases/tables_of_contents/create_and_include_page_toc/use_case_builder.rb
|
|
211
206
|
- markdown/use_cases/tables_of_contents/create_and_include_page_toc/use_case_template.md
|
|
212
207
|
- markdown/use_cases/tables_of_contents/create_page_toc_use_case.rb
|
|
213
208
|
- markdown/use_cases/use_case.rb
|
|
@@ -233,7 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
233
228
|
version: '0'
|
|
234
229
|
requirements: []
|
|
235
230
|
rubyforge_project:
|
|
236
|
-
rubygems_version: 2.
|
|
231
|
+
rubygems_version: 2.7.6
|
|
237
232
|
signing_key:
|
|
238
233
|
specification_version: 4
|
|
239
234
|
summary: Class to help with GitHub markdown.
|
data/bin/_resolve
DELETED
|
@@ -1,46 +0,0 @@
|
|
|
1
|
-
#!/usr/bin/env ruby
|
|
2
|
-
|
|
3
|
-
require 'optparse'
|
|
4
|
-
|
|
5
|
-
require 'markdown_helper'
|
|
6
|
-
|
|
7
|
-
options = {:pristine => false}
|
|
8
|
-
|
|
9
|
-
# Save opts for use below.
|
|
10
|
-
opts = nil
|
|
11
|
-
parser = OptionParser.new do |_opts|
|
|
12
|
-
opts = _opts
|
|
13
|
-
_opts.banner = "Usage: markdown_helper resolve [options] template_file_path markdown_file_path"
|
|
14
|
-
_opts.on('--pristine', 'No comments added') do |_|
|
|
15
|
-
options[:pristine] = true
|
|
16
|
-
end
|
|
17
|
-
_opts.on('--help', 'Display help') do
|
|
18
|
-
usage(_opts)
|
|
19
|
-
end
|
|
20
|
-
end
|
|
21
|
-
|
|
22
|
-
def usage(opts)
|
|
23
|
-
puts ''
|
|
24
|
-
puts opts
|
|
25
|
-
puts <<-EOT
|
|
26
|
-
|
|
27
|
-
where
|
|
28
|
-
|
|
29
|
-
* template_file_path is the path to an existing file.
|
|
30
|
-
* markdown_file_path is the path to a file to be created.
|
|
31
|
-
|
|
32
|
-
Typically:
|
|
33
|
-
|
|
34
|
-
* Both file types are .md.
|
|
35
|
-
* The template file contains image descriptions.
|
|
36
|
-
EOT
|
|
37
|
-
exit
|
|
38
|
-
end
|
|
39
|
-
|
|
40
|
-
parser.parse!
|
|
41
|
-
|
|
42
|
-
_, template_file_path, markdown_file_path = ARGV
|
|
43
|
-
|
|
44
|
-
usage(opts) unless ARGV.size == 3
|
|
45
|
-
|
|
46
|
-
MarkdownHelper.new(options).resolve(template_file_path, markdown_file_path)
|