Skip to content

Commit 5655856

Browse files
authored
Add pre post message example for scaffold readme (#232)
1 parent e7cd627 commit 5655856

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -252,6 +252,20 @@ In this example:
252252
* "support" -> "body" uses a remote Markdown file as the section contents. This can also be a local file path, or a string.
253253
* "show_powered_by" shows or hides the Powered By mention at the end of the readme.
254254

255+
For sections, "pre", "body" and "post" are supported. Example:
256+
```
257+
"support": {
258+
"pre": "highlight.md",
259+
"body": "https://raw.githubusercontent.com/runcommand/runcommand-theme/master/bin/readme-partials/support-open-source.md",
260+
"post": "This is additional text to show after main body content."
261+
},
262+
```
263+
In this example:
264+
265+
* "pre" content is pulled from local highlight.md file.
266+
* "body" content is pulled from remote URL.
267+
* "post" is a string.
268+
255269
**OPTIONS**
256270

257271
<dir>

src/ScaffoldPackageCommand.php

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,20 @@ public function package( $args, $assoc_args ) {
208208
* * "support" -> "body" uses a remote Markdown file as the section contents. This can also be a local file path, or a string.
209209
* * "show_powered_by" shows or hides the Powered By mention at the end of the readme.
210210
*
211+
* For sections, "pre", "body" and "post" are supported. Example:
212+
* ```
213+
* "support": {
214+
* "pre": "highlight.md",
215+
* "body": "https://raw.githubusercontent.com/runcommand/runcommand-theme/master/bin/readme-partials/support-open-source.md",
216+
* "post": "This is additional text to show after main body content."
217+
* },
218+
* ```
219+
* In this example:
220+
*
221+
* * "pre" content is pulled from local highlight.md file.
222+
* * "body" content is pulled from remote URL.
223+
* * "post" is a string.
224+
*
211225
* ## OPTIONS
212226
*
213227
* <dir>

0 commit comments

Comments
 (0)