https://github.com/wp-cli/handbook

📖 Complete documentation for WP-CLI
https://github.com/wp-cli/handbook

cli docs documentation documentations hacktoberfest handbook wordpress wp-cli

Last synced: 5 days ago
JSON representation

📖 Complete documentation for WP-CLI

• Host: GitHub
• URL: https://github.com/wp-cli/handbook
• Owner: wp-cli
• License: mit
• Created: 2017-01-19T16:52:02.000Z (almost 8 years ago)
• Default Branch: main
• Last Pushed: 2024-09-17T16:57:23.000Z (about 2 months ago)
• Last Synced: 2024-09-18T05:11:11.424Z (about 2 months ago)
• Topics: cli, docs, documentation, documentations, hacktoberfest, handbook, wordpress, wp-cli
• Language: PHP
• Homepage: https://make.wordpress.org/cli/handbook/
• Size: 1.83 MB
• Stars: 188
• Watchers: 16
• Forks: 329
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • Contributing: contributing.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS
  • Governance: governance.md
  • Roadmap: roadmap.md

Awesome Lists containing this project

README

        
wp-cli/handbook

===============

These files comprise the WP-CLI handbook ([make.wordpress.org/cli/handbook](https://make.wordpress.org/cli/handbook/)) and WP-CLI commands directory ([developer.wordpress.org/cli/commands](https://developer.wordpress.org/cli/commands/)).

The documentation is located in GitHub to enable a pull request-based editing workflow.

Long-form documentation (e.g. "Commands cookbook") can be edited directly.

Internal API docs and command pages are generated dynamically from the WP-CLI codebase using the `wp handbook` series of commands.

Before running these commands the bash script `bin/install-packages.sh` should be run to install the latest versions of the non-bundled commands in `bin/packages`. Note `wp` must point to the target WP-CLI instance, i.e. the phar/git that contains the docblocks to be generated against, and should be run with `WP_CLI_PACKAGES_DIR=bin/packages` and `WP_CLI_CONFIG_PATH=/dev/null`.

So for instance to generate all dynamically created documentation against the nightly phar run:

```

wp cli update --nightly

bin/install_packages.sh

WP_CLI_PACKAGES_DIR=bin/packages WP_CLI_CONFIG_PATH=/dev/null wp handbook gen-all

```

All documentation is imported automatically into WordPress.org in a two step process:

1. WordPress reads `commands-manifest.json` or `handbook-manifest.json` to understand all pages that need to be created.

2. Each WordPress page has a `markdown_source` attribute specifying a Markdown file to be fetched, converted to HTML, and saved in the database.

For make.wordpress.org/cli, the import process is a [WordPress plugin](https://meta.trac.wordpress.org/browser/sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-cli/inc/class-markdown-import.php) running a WP Cron job every 15 minutes. For developer.wordpress.org/cli, this is a [class in the devhub theme](https://meta.trac.wordpress.org/browser/sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/cli.php) running a WP Cron job every 12 hours.