readme_yard 0.5.0 → 0.6.0
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/.yardopts +3 -0
- data/CHANGELOG.md +4 -0
- data/Gemfile.lock +3 -1
- data/README.md +1 -1
- data/docs/ReadmeYard/CodeTag.html +2 -3
- data/docs/ReadmeYard/CommentTag.html +4 -8
- data/docs/ReadmeYard/Error.html +2 -4
- data/docs/ReadmeYard/ExampleTag.html +6 -11
- data/docs/ReadmeYard/Logger.html +4 -7
- data/docs/ReadmeYard/ReadmeTag.html +3 -5
- data/docs/ReadmeYard/SourceTag.html +2 -3
- data/docs/ReadmeYard/StringTag.html +17 -11
- data/docs/ReadmeYard/TagRegistry.html +3 -5
- data/docs/ReadmeYard/ValueTag.html +3 -5
- data/docs/ReadmeYard/YardOptsManager.html +18 -22
- data/docs/ReadmeYard.html +8 -10
- data/docs/_index.html +1 -1
- data/docs/file.README.html +166 -174
- data/docs/index.html +166 -174
- data/docs/top-level-namespace.html +1 -1
- data/lib/readme_yard/version.rb +1 -1
- data/lib/readme_yard/yard_opts_manager.rb +3 -2
- data/readme_yard.gemspec +1 -0
- metadata +15 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b2cf986578dc23e8a313eafee09111175b6ea7f895c5182f07d952d456b8692d
|
4
|
+
data.tar.gz: d9bc293399f283d3665a840b368d2615079bed87d9e2a6cc3bbd890dbea5569e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7aba0318f90b8a7addd26ebf5ba72f4bfc5d1aabac292d310b8426ab12359b018d33ca5a87bf339f9e53ac5be36474350ecbfe3bd49d674c3398240f4bd8ef63
|
7
|
+
data.tar.gz: 24f730ca55e0306fc04d90ce65d0337f7cf2380d743f2bfca8809a51e4022945e2012c74a633705b558e271e305dcdd8179c04bfa5a6861f8163185e38f97a6d
|
data/.yardopts
CHANGED
data/CHANGELOG.md
CHANGED
data/Gemfile.lock
CHANGED
@@ -1,8 +1,9 @@
|
|
1
1
|
PATH
|
2
2
|
remote: .
|
3
3
|
specs:
|
4
|
-
readme_yard (0.
|
4
|
+
readme_yard (0.6.0)
|
5
5
|
diffy (~> 3.4)
|
6
|
+
redcarpet (~> 3.6)
|
6
7
|
tty-markdown (~> 0.7)
|
7
8
|
yard (~> 0.9)
|
8
9
|
yard-readme (~> 0.5)
|
@@ -43,6 +44,7 @@ GEM
|
|
43
44
|
rainbow (3.1.1)
|
44
45
|
rdoc (6.13.1)
|
45
46
|
psych (>= 4.0.0)
|
47
|
+
redcarpet (3.6.1)
|
46
48
|
regexp_parser (2.10.0)
|
47
49
|
reline (0.6.1)
|
48
50
|
io-console (~> 0.5)
|
data/README.md
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
# Readme Yard 🌿
|
2
2
|
[](https://badge.fury.io/rb/readme_yard)
|
3
3
|
|
4
|
-
**Code Version: 0.
|
4
|
+
**Code Version: 0.6.0**
|
5
5
|
|
6
6
|
Build a better README with [YARD](https://yardoc.org)
|
7
7
|
by generating it straight from the source.
|
@@ -172,8 +172,7 @@
|
|
172
172
|
|
173
173
|
|
174
174
|
|
175
|
-
<span class="summary_desc"><div class='inline'>
|
176
|
-
</div></span>
|
175
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
177
176
|
|
178
177
|
</li>
|
179
178
|
|
@@ -263,7 +262,7 @@
|
|
263
262
|
</div>
|
264
263
|
|
265
264
|
<div id="footer">
|
266
|
-
Generated on
|
265
|
+
Generated on Fri May 9 00:45:02 2025 by
|
267
266
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
268
267
|
0.9.37 (ruby-3.4.2).
|
269
268
|
</div>
|
@@ -149,8 +149,7 @@
|
|
149
149
|
|
150
150
|
|
151
151
|
|
152
|
-
<span class="summary_desc"><div class='inline'>
|
153
|
-
</div></span>
|
152
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
154
153
|
|
155
154
|
</li>
|
156
155
|
|
@@ -195,8 +194,7 @@
|
|
195
194
|
|
196
195
|
|
197
196
|
|
198
|
-
<span class="summary_desc"><div class='inline'>
|
199
|
-
</div></span>
|
197
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
200
198
|
|
201
199
|
</li>
|
202
200
|
|
@@ -218,8 +216,7 @@
|
|
218
216
|
|
219
217
|
|
220
218
|
|
221
|
-
<span class="summary_desc"><div class='inline'>
|
222
|
-
</div></span>
|
219
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
223
220
|
|
224
221
|
</li>
|
225
222
|
|
@@ -246,7 +243,6 @@
|
|
246
243
|
<div class="discussion">
|
247
244
|
|
248
245
|
|
249
|
-
|
250
246
|
</div>
|
251
247
|
</div>
|
252
248
|
<div class="tags">
|
@@ -408,7 +404,7 @@ is below (in the source code).</p>
|
|
408
404
|
</div>
|
409
405
|
|
410
406
|
<div id="footer">
|
411
|
-
Generated on
|
407
|
+
Generated on Fri May 9 00:45:02 2025 by
|
412
408
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
413
409
|
0.9.37 (ruby-3.4.2).
|
414
410
|
</div>
|
data/docs/ReadmeYard/Error.html
CHANGED
@@ -133,8 +133,7 @@
|
|
133
133
|
|
134
134
|
|
135
135
|
|
136
|
-
<span class="summary_desc"><div class='inline'>
|
137
|
-
</div></span>
|
136
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
138
137
|
|
139
138
|
</li>
|
140
139
|
|
@@ -171,7 +170,6 @@ Look for the object path in other scopes.</p>
|
|
171
170
|
|
172
171
|
|
173
172
|
|
174
|
-
|
175
173
|
</div>
|
176
174
|
</div>
|
177
175
|
<div class="tags">
|
@@ -207,7 +205,7 @@ Look for the object path in other scopes.</p>
|
|
207
205
|
</div>
|
208
206
|
|
209
207
|
<div id="footer">
|
210
|
-
Generated on
|
208
|
+
Generated on Fri May 9 00:45:02 2025 by
|
211
209
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
212
210
|
0.9.37 (ruby-3.4.2).
|
213
211
|
</div>
|
@@ -101,7 +101,7 @@
|
|
101
101
|
|
102
102
|
<h2>Overview</h2><div class="docstring">
|
103
103
|
<div class="discussion">
|
104
|
-
<p>The Example Tag leverages YARD
|
104
|
+
<p>The Example Tag leverages YARD's standard <code>@example</code> tag syntax, allowing you to
|
105
105
|
include example code in your README directly from source files. This saves time and
|
106
106
|
ensures your README stays in sync with your YARD documentation</p>
|
107
107
|
|
@@ -143,8 +143,7 @@ ensures your README stays in sync with your YARD documentation</p>
|
|
143
143
|
|
144
144
|
|
145
145
|
|
146
|
-
<span class="summary_desc"><div class='inline'>
|
147
|
-
</div></span>
|
146
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
148
147
|
|
149
148
|
</li>
|
150
149
|
|
@@ -166,8 +165,7 @@ ensures your README stays in sync with your YARD documentation</p>
|
|
166
165
|
|
167
166
|
|
168
167
|
|
169
|
-
<span class="summary_desc"><div class='inline'>
|
170
|
-
</div></span>
|
168
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
171
169
|
|
172
170
|
</li>
|
173
171
|
|
@@ -189,8 +187,7 @@ ensures your README stays in sync with your YARD documentation</p>
|
|
189
187
|
|
190
188
|
|
191
189
|
|
192
|
-
<span class="summary_desc"><div class='inline'>
|
193
|
-
</div></span>
|
190
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
194
191
|
|
195
192
|
</li>
|
196
193
|
|
@@ -212,8 +209,7 @@ ensures your README stays in sync with your YARD documentation</p>
|
|
212
209
|
|
213
210
|
|
214
211
|
|
215
|
-
<span class="summary_desc"><div class='inline'>
|
216
|
-
</div></span>
|
212
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
217
213
|
|
218
214
|
</li>
|
219
215
|
|
@@ -332,7 +328,6 @@ ensures your README stays in sync with your YARD documentation</p>
|
|
332
328
|
<div class="discussion">
|
333
329
|
|
334
330
|
|
335
|
-
|
336
331
|
</div>
|
337
332
|
</div>
|
338
333
|
<div class="tags">
|
@@ -372,7 +367,7 @@ ensures your README stays in sync with your YARD documentation</p>
|
|
372
367
|
</div>
|
373
368
|
|
374
369
|
<div id="footer">
|
375
|
-
Generated on
|
370
|
+
Generated on Fri May 9 00:45:02 2025 by
|
376
371
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
377
372
|
0.9.37 (ruby-3.4.2).
|
378
373
|
</div>
|
data/docs/ReadmeYard/Logger.html
CHANGED
@@ -131,8 +131,7 @@
|
|
131
131
|
|
132
132
|
|
133
133
|
|
134
|
-
<span class="summary_desc"><div class='inline'>
|
135
|
-
</div></span>
|
134
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
136
135
|
|
137
136
|
</li>
|
138
137
|
|
@@ -154,8 +153,7 @@
|
|
154
153
|
|
155
154
|
|
156
155
|
|
157
|
-
<span class="summary_desc"><div class='inline'>
|
158
|
-
</div></span>
|
156
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
159
157
|
|
160
158
|
</li>
|
161
159
|
|
@@ -177,8 +175,7 @@
|
|
177
175
|
|
178
176
|
|
179
177
|
|
180
|
-
<span class="summary_desc"><div class='inline'>
|
181
|
-
</div></span>
|
178
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
182
179
|
|
183
180
|
</li>
|
184
181
|
|
@@ -289,7 +286,7 @@
|
|
289
286
|
</div>
|
290
287
|
|
291
288
|
<div id="footer">
|
292
|
-
Generated on
|
289
|
+
Generated on Fri May 9 00:45:02 2025 by
|
293
290
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
294
291
|
0.9.37 (ruby-3.4.2).
|
295
292
|
</div>
|
@@ -158,8 +158,7 @@ embed behavior can be changed through the use of tag names.</p>
|
|
158
158
|
|
159
159
|
|
160
160
|
|
161
|
-
<span class="summary_desc"><div class='inline'>
|
162
|
-
</div></span>
|
161
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
163
162
|
|
164
163
|
</li>
|
165
164
|
|
@@ -181,8 +180,7 @@ embed behavior can be changed through the use of tag names.</p>
|
|
181
180
|
|
182
181
|
|
183
182
|
|
184
|
-
<span class="summary_desc"><div class='inline'>
|
185
|
-
</div></span>
|
183
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
186
184
|
|
187
185
|
</li>
|
188
186
|
|
@@ -271,7 +269,7 @@ embed behavior can be changed through the use of tag names.</p>
|
|
271
269
|
</div>
|
272
270
|
|
273
271
|
<div id="footer">
|
274
|
-
Generated on
|
272
|
+
Generated on Fri May 9 00:45:02 2025 by
|
275
273
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
276
274
|
0.9.37 (ruby-3.4.2).
|
277
275
|
</div>
|
@@ -172,8 +172,7 @@
|
|
172
172
|
|
173
173
|
|
174
174
|
|
175
|
-
<span class="summary_desc"><div class='inline'>
|
176
|
-
</div></span>
|
175
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
177
176
|
|
178
177
|
</li>
|
179
178
|
|
@@ -267,7 +266,7 @@ is in the README because <code>@readme source</code> is below (in the source cod
|
|
267
266
|
</div>
|
268
267
|
|
269
268
|
<div id="footer">
|
270
|
-
Generated on
|
269
|
+
Generated on Fri May 9 00:45:02 2025 by
|
271
270
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
272
271
|
0.9.37 (ruby-3.4.2).
|
273
272
|
</div>
|
@@ -123,7 +123,6 @@
|
|
123
123
|
<div class="discussion">
|
124
124
|
|
125
125
|
|
126
|
-
|
127
126
|
</div>
|
128
127
|
</div>
|
129
128
|
<div class="tags">
|
@@ -178,8 +177,7 @@
|
|
178
177
|
|
179
178
|
|
180
179
|
|
181
|
-
<span class="summary_desc"><div class='inline'>
|
182
|
-
</div></span>
|
180
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
183
181
|
|
184
182
|
</li>
|
185
183
|
|
@@ -201,8 +199,7 @@
|
|
201
199
|
|
202
200
|
|
203
201
|
|
204
|
-
<span class="summary_desc"><div class='inline'>
|
205
|
-
</div></span>
|
202
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
206
203
|
|
207
204
|
</li>
|
208
205
|
|
@@ -224,8 +221,7 @@
|
|
224
221
|
|
225
222
|
|
226
223
|
|
227
|
-
<span class="summary_desc"><div class='inline'>
|
228
|
-
</div></span>
|
224
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
229
225
|
|
230
226
|
</li>
|
231
227
|
|
@@ -349,7 +345,12 @@
|
|
349
345
|
57
|
350
346
|
58
|
351
347
|
59
|
352
|
-
60
|
348
|
+
60
|
349
|
+
61
|
350
|
+
62
|
351
|
+
63
|
352
|
+
64
|
353
|
+
65</pre>
|
353
354
|
</td>
|
354
355
|
<td>
|
355
356
|
<pre class="code"><span class="info file"># File 'lib/readme_yard/string_tag.rb', line 33</span>
|
@@ -363,8 +364,13 @@
|
|
363
364
|
</span> <span class='kw'>return</span> <span class='id identifier rubyid_normalize_value_for_heredoc'>normalize_value_for_heredoc</span><span class='lparen'>(</span><span class='id identifier rubyid_string_value'>string_value</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_string_value'>string_value</span><span class='period'>.</span><span class='id identifier rubyid_strip'>strip</span><span class='period'>.</span><span class='id identifier rubyid_start_with?'>start_with?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'><<~</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
364
365
|
|
365
366
|
<span class='comment'># Handle regular string format
|
366
|
-
</span> <span class='id identifier rubyid_string_value'>string_value</span><span class='period'>.</span><span class='id identifier
|
367
|
-
|
367
|
+
</span> <span class='kw'>if</span> <span class='id identifier rubyid_string_value'>string_value</span><span class='period'>.</span><span class='id identifier rubyid_start_with?'>start_with?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>"</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
368
|
+
<span class='id identifier rubyid_string_value'>string_value</span><span class='period'>.</span><span class='id identifier rubyid_delete_prefix!'>delete_prefix!</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>"</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
369
|
+
<span class='id identifier rubyid_string_value'>string_value</span><span class='period'>.</span><span class='id identifier rubyid_delete_suffix!'>delete_suffix!</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>"</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
370
|
+
<span class='kw'>elsif</span> <span class='id identifier rubyid_string_value'>string_value</span><span class='period'>.</span><span class='id identifier rubyid_start_with?'>start_with?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>'</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
371
|
+
<span class='id identifier rubyid_string_value'>string_value</span><span class='period'>.</span><span class='id identifier rubyid_delete_prefix!'>delete_prefix!</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>'</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
372
|
+
<span class='id identifier rubyid_string_value'>string_value</span><span class='period'>.</span><span class='id identifier rubyid_delete_suffix!'>delete_suffix!</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>'</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
373
|
+
<span class='kw'>end</span>
|
368
374
|
|
369
375
|
<span class='comment'># Replace different line continuation patterns
|
370
376
|
</span> <span class='comment'># This handles patterns like: " \\\n" and \\\n"
|
@@ -392,7 +398,7 @@
|
|
392
398
|
</div>
|
393
399
|
|
394
400
|
<div id="footer">
|
395
|
-
Generated on
|
401
|
+
Generated on Fri May 9 00:45:02 2025 by
|
396
402
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
397
403
|
0.9.37 (ruby-3.4.2).
|
398
404
|
</div>
|
@@ -153,8 +153,7 @@
|
|
153
153
|
|
154
154
|
|
155
155
|
|
156
|
-
<span class="summary_desc"><div class='inline'>
|
157
|
-
</div></span>
|
156
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
158
157
|
|
159
158
|
</li>
|
160
159
|
|
@@ -176,8 +175,7 @@
|
|
176
175
|
|
177
176
|
|
178
177
|
|
179
|
-
<span class="summary_desc"><div class='inline'>
|
180
|
-
</div></span>
|
178
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
181
179
|
|
182
180
|
</li>
|
183
181
|
|
@@ -256,7 +254,7 @@
|
|
256
254
|
</div>
|
257
255
|
|
258
256
|
<div id="footer">
|
259
|
-
Generated on
|
257
|
+
Generated on Fri May 9 00:45:02 2025 by
|
260
258
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
261
259
|
0.9.37 (ruby-3.4.2).
|
262
260
|
</div>
|
@@ -165,8 +165,7 @@
|
|
165
165
|
|
166
166
|
|
167
167
|
|
168
|
-
<span class="summary_desc"><div class='inline'>
|
169
|
-
</div></span>
|
168
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
170
169
|
|
171
170
|
</li>
|
172
171
|
|
@@ -188,8 +187,7 @@
|
|
188
187
|
|
189
188
|
|
190
189
|
|
191
|
-
<span class="summary_desc"><div class='inline'>
|
192
|
-
</div></span>
|
190
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
193
191
|
|
194
192
|
</li>
|
195
193
|
|
@@ -276,7 +274,7 @@
|
|
276
274
|
</div>
|
277
275
|
|
278
276
|
<div id="footer">
|
279
|
-
Generated on
|
277
|
+
Generated on Fri May 9 00:45:02 2025 by
|
280
278
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
281
279
|
0.9.37 (ruby-3.4.2).
|
282
280
|
</div>
|
@@ -147,8 +147,7 @@
|
|
147
147
|
|
148
148
|
|
149
149
|
|
150
|
-
<span class="summary_desc"><div class='inline'>
|
151
|
-
</div></span>
|
150
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
152
151
|
|
153
152
|
</li>
|
154
153
|
|
@@ -170,8 +169,7 @@
|
|
170
169
|
|
171
170
|
|
172
171
|
|
173
|
-
<span class="summary_desc"><div class='inline'>
|
174
|
-
</div></span>
|
172
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
175
173
|
|
176
174
|
</li>
|
177
175
|
|
@@ -193,8 +191,7 @@
|
|
193
191
|
|
194
192
|
|
195
193
|
|
196
|
-
<span class="summary_desc"><div class='inline'>
|
197
|
-
</div></span>
|
194
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
198
195
|
|
199
196
|
</li>
|
200
197
|
|
@@ -216,8 +213,7 @@
|
|
216
213
|
|
217
214
|
|
218
215
|
|
219
|
-
<span class="summary_desc"><div class='inline'>
|
220
|
-
</div></span>
|
216
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
221
217
|
|
222
218
|
</li>
|
223
219
|
|
@@ -239,8 +235,7 @@
|
|
239
235
|
|
240
236
|
|
241
237
|
|
242
|
-
<span class="summary_desc"><div class='inline'>
|
243
|
-
</div></span>
|
238
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
244
239
|
|
245
240
|
</li>
|
246
241
|
|
@@ -262,8 +257,7 @@
|
|
262
257
|
|
263
258
|
|
264
259
|
|
265
|
-
<span class="summary_desc"><div class='inline'>
|
266
|
-
</div></span>
|
260
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
267
261
|
|
268
262
|
</li>
|
269
263
|
|
@@ -321,7 +315,7 @@
|
|
321
315
|
<span class='id identifier rubyid_warn_about_supported_markdown'>warn_about_supported_markdown</span>
|
322
316
|
<span class='id identifier rubyid_readme_plugin_opts'>readme_plugin_opts</span>
|
323
317
|
<span class='kw'>else</span>
|
324
|
-
<span class='id identifier rubyid_readme_plugin_opts'>readme_plugin_opts</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>--markup markdown\n</span><span class='tstring_end'>"</span></span>
|
318
|
+
<span class='id identifier rubyid_readme_plugin_opts'>readme_plugin_opts</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>--markup markdown\n--markup-provider redcarpet\n</span><span class='tstring_end'>"</span></span>
|
325
319
|
<span class='kw'>end</span>
|
326
320
|
<span class='kw'>end</span></pre>
|
327
321
|
</td>
|
@@ -344,12 +338,12 @@
|
|
344
338
|
<pre class="lines">
|
345
339
|
|
346
340
|
|
347
|
-
39
|
348
341
|
40
|
349
|
-
41
|
342
|
+
41
|
343
|
+
42</pre>
|
350
344
|
</td>
|
351
345
|
<td>
|
352
|
-
<pre class="code"><span class="info file"># File 'lib/readme_yard/yard_opts_manager.rb', line
|
346
|
+
<pre class="code"><span class="info file"># File 'lib/readme_yard/yard_opts_manager.rb', line 40</span>
|
353
347
|
|
354
348
|
<span class='kw'>def</span> <span class='id identifier rubyid_create_yardopts_file'>create_yardopts_file</span>
|
355
349
|
<span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="#YARDOPTS_FILE-constant" title="ReadmeYard::YardOptsManager::YARDOPTS_FILE (constant)">YARDOPTS_FILE</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>--plugin readme\n--markup markdown\n</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
@@ -378,14 +372,16 @@
|
|
378
372
|
34
|
379
373
|
35
|
380
374
|
36
|
381
|
-
37
|
375
|
+
37
|
376
|
+
38</pre>
|
382
377
|
</td>
|
383
378
|
<td>
|
384
379
|
<pre class="code"><span class="info file"># File 'lib/readme_yard/yard_opts_manager.rb', line 33</span>
|
385
380
|
|
386
381
|
<span class='kw'>def</span> <span class='id identifier rubyid_default_readme_plugin_opts'>default_readme_plugin_opts</span><span class='lparen'>(</span><span class='id identifier rubyid_yardopts_text'>yardopts_text</span><span class='rparen'>)</span>
|
387
382
|
<span class='id identifier rubyid_readme_opts'>readme_opts</span> <span class='op'>=</span> <span class='op'>+</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
388
|
-
<span class='id identifier
|
383
|
+
<span class='id identifier rubyid_last_line'>last_line</span> <span class='op'>=</span> <span class='id identifier rubyid_yardopts_text'>yardopts_text</span><span class='period'>.</span><span class='id identifier rubyid_lines'>lines</span><span class='period'>.</span><span class='id identifier rubyid_last'>last</span>
|
384
|
+
<span class='id identifier rubyid_readme_opts'>readme_opts</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_last_line'>last_line</span> <span class='op'>&&</span> <span class='op'>!</span><span class='id identifier rubyid_last_line'>last_line</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
389
385
|
<span class='id identifier rubyid_readme_opts'>readme_opts</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>--plugin readme\n</span><span class='tstring_end'>"</span></span>
|
390
386
|
<span class='kw'>end</span></pre>
|
391
387
|
</td>
|
@@ -472,13 +468,13 @@
|
|
472
468
|
<pre class="lines">
|
473
469
|
|
474
470
|
|
475
|
-
43
|
476
471
|
44
|
477
472
|
45
|
478
|
-
46
|
473
|
+
46
|
474
|
+
47</pre>
|
479
475
|
</td>
|
480
476
|
<td>
|
481
|
-
<pre class="code"><span class="info file"># File 'lib/readme_yard/yard_opts_manager.rb', line
|
477
|
+
<pre class="code"><span class="info file"># File 'lib/readme_yard/yard_opts_manager.rb', line 44</span>
|
482
478
|
|
483
479
|
<span class='kw'>def</span> <span class='id identifier rubyid_warn_about_supported_markdown'>warn_about_supported_markdown</span>
|
484
480
|
<span class='const'><span class='object_link'><a href="Logger.html" title="ReadmeYard::Logger (class)">Logger</a></span></span><span class='period'>.</span><span class='id identifier rubyid_warn'><span class='object_link'><a href="Logger.html#warn-class_method" title="ReadmeYard::Logger.warn (method)">warn</a></span></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>*Readme Yard* works best with markdown. </span><span class='tstring_end'>"</span></span> \
|
@@ -494,7 +490,7 @@
|
|
494
490
|
</div>
|
495
491
|
|
496
492
|
<div id="footer">
|
497
|
-
Generated on
|
493
|
+
Generated on Fri May 9 00:45:02 2025 by
|
498
494
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
499
495
|
0.9.37 (ruby-3.4.2).
|
500
496
|
</div>
|