此命令在 before_wp_load 钩子上运行,恰好在WP加载过程开始之前。它根据WP-CLI包的 composer.json 文件,生成包含使用、安装和贡献说明的 README.md 文件。建议在项目开始时运行此命令,并在每次使用文档发生变更时重新运行。
| 参数 | 说明 |
|---|---|
<dir> |
现有包目录路径,用于生成readme。 |
[--force] |
如果readme已存在则覆盖。 |
[--branch=<branch>] |
底层仓库的默认分支名称。默认为 master。 |
$ wp package install wp-cli/scaffold-package-command
$ wp scaffold package-readme /path/to/package