wp-cli/scaffold-package-command
2
0
Fork 0
mirror of https://ghproxy.net/https://github.com/wp-cli/scaffold-package-command.git synced 2025-08-20 22:57:27 +08:00
Code Issues Projects Packages Activity Actions

Add pre post message example for scaffold readme

Browse source
This commit is contained in:
Nilambar Sharma 2024-03-12 10:44:32 +05:45
parent e7cd627f02
commit ac48f020bc
2 changed files with 28 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -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://raw.githubusercontent.com/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>

14
src/ScaffoldPackageCommand.php
View file

@ -208,6 +208,20 @@ EOT;
* * "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://raw.githubusercontent.com/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>