These files comprise wp-cli.org*.
All command documentation is dynamically generated from the PHPDoc for each command. If you'd like to suggest command documentation changes, please submit a pull request against the primary repo. Command documentation changes are deployed to the website with each release.
The website uses a series of WP-CLI commands to generate its documentation:
NAME
wp website
SYNOPSIS
wp website <command>
SUBCOMMANDS
generate Run all generation commands to generate full website.
generate-commands Generate the /commands/ page.
generate-config Generate the /config/ page.
generate-contributing Generate the contributing page from WP-CLI's CONTRIBUTING.md
generate-docs Generate the /docs/ page.
generate-homepage Generate the homepage from WP-CLI's README.md
generate-internal-api-docs Generate the /docs/internal-apis/ page.
- Install Bundler gem:
gem install bundler
. - Install dependencies:
bundle install
- Run
jekyll serve --watch
*wp-cli.org/package-index is generated by the package index repo, and won't be present in your local instance.
- Add your language to
[_config.yml](https://github.com/wp-cli/wp-cli.github.com/blob/main/_config.yml)
. - Create a folder under the name of your appropriate language code (IETF language tag). e.g. ja or pt_BR
- Copy the English
index.md
into your language's directory. - Translate
index.md
.
Note: Please avoid using a language file other than the English one in the root folder as your source for translating, as it might not be up-to-date. The root index.md
is considered to be the source of truth and is the only one guaranteed to be current.