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](https://github.com/wp-cli/wp-cli). Command documentation changes are deployed to the website with each release.

### Regenerate website

The website uses a series of WP-CLI commands to generate its documentation:

```bash
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.
```

### Preview locally

1. [Install Bundler gem](http://jekyllrb.com/docs/installation/): `gem install bundler`.
2. [Install dependencies](http://jekyllrb.com/docs/installation/): `bundle install`
3. Run `jekyll serve --watch`

*wp-cli.org/package-index is generated by the [package index repo](https://github.com/wp-cli/package-index), and won't be present in your local instance.

### How to translate

1. Add your language to `[_config.yml](https://github.com/wp-cli/wp-cli.github.com/blob/main/_config.yml)`.
2. Create a folder under the name of your appropriate language code (IETF language tag). e.g. ja or pt_BR
3. Copy the *English* `index.md` into your language's directory.
4. 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.