Generate WooCommerce Code Reference.
git clone https://github.com/woocommerce/code-reference.gitcd code-reference
./deploy.sh -s <VERSION>For local development and testing with your own WooCommerce installation:
cd code-reference
./run-local.shThe 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 | Description |
|---|---|
-h or --help |
Show help information. |
-v or --verbose |
Increase verbosity. Useful for debugging. |
-s <VERSION> or --source-version <VERSION> |
Source version to build and deploy. |
-r <GITHUB_REPO> or --github-repo <GITHUB_REPO> |
GitHub repo with username, default to "woocommerce/woocommerce". |
-e or --allow-empty |
Allow deployment of an empty directory. |
-m <MESSAGE> or --message <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. |