https://github.com/woocommerce/code-reference
WooCommerce Code Reference Generator
https://github.com/woocommerce/code-reference
woocommerce
Last synced: 3 months ago
JSON representation
WooCommerce Code Reference Generator
- Host: GitHub
- URL: https://github.com/woocommerce/code-reference
- Owner: woocommerce
- License: gpl-3.0
- Created: 2019-06-26T00:15:44.000Z (over 6 years ago)
- Default Branch: trunk
- Last Pushed: 2025-08-27T23:09:27.000Z (5 months ago)
- Last Synced: 2025-08-28T07:14:03.083Z (5 months ago)
- Topics: woocommerce
- Language: Twig
- Homepage: https://woocommerce.github.io/code-reference/
- Size: 8.38 MB
- Stars: 17
- Watchers: 5
- Forks: 13
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# WooCommerce Code Reference Generator
Generate [WooCommerce Code Reference](https://woocommerce.github.io/code-reference/).
## Install
```bash
git clone https://github.com/woocommerce/code-reference.git
```
## Usage
### Production Deployment
```bash
cd code-reference
./deploy.sh -s
```
### Local Development
For local development and testing with your own WooCommerce installation:
```bash
cd code-reference
./run-local.sh
```
The script will prompt you for the path to your WooCommerce plugin directory. This should be the directory containing the main WooCommerce plugin files (e.g., `Users/YourUserName/woocommerce/plugins/woocommerce`).
After generation, the Documenation will be served from the `build/api` folder.
A local web server will start at `http://localhost:8000`.
### Options
| Options | Description |
| --------------------------------------------------- | --------------------------------------------------------------------- |
| `-h` or `--help` | Show help information. |
| `-v` or `--verbose` | Increase verbosity. Useful for debugging. |
| `-s ` or `--source-version ` | Source version to build and deploy. |
| `-r ` or `--github-repo ` | GitHub repo with username, default to \"woocommerce/woocommerce\". |
| `-e` or `--allow-empty` | Allow deployment of an empty directory. |
| `-m ` or `--message ` | Specify the message used when committing on the deploy branch. |
| `-n` or `--no-hash` | Don't append the source commit's hash to the deploy commit's message. |
| `--build-only` | Only build but not push. |
| `--push-only` | Only push but not build. |
| `--no-download` | Skip zip download in case there's on in the project's root. |
## Changelog
[See changelog for details](https://github.com/woocommerce/code-reference/blob/master/CHANGELOG.md)