WooCommerce REST API Documentation http://woocommerce.github.io/woocommerce-rest-api-docs/
Find a file
Luigi Teschio 75a75a29ea
Some checks failed
Deploy on push / Build and deploy (push) Has been cancelled
Merge pull request #273 from woocommerce/update/products-documentation-images
Add new fields to image attributes in products documentation
2025-09-22 17:02:28 +02:00
.github/workflows Pin Github actions to immutable references of commits 2025-06-19 17:33:50 +03:00
source Merge pull request #273 from woocommerce/update/products-documentation-images 2025-09-22 17:02:28 +02:00
.editorconfig Updated slate 2018-10-16 00:55:07 -03:00
.gitignore Updated slate 2018-10-16 00:55:07 -03:00
build.sh Coding standards 2021-03-13 19:33:54 -03:00
deploy.sh Remove old framework files and replace with Docker 2021-03-13 00:24:30 -03:00
font-selection.json Updated slate to 1.2 2015-07-13 07:08:22 -03:00
LICENSE Updated slate to 1.2 2015-07-13 07:08:22 -03:00
README.md Update readme with more details about building and deploying 2024-07-17 16:29:43 -07:00

WooCommerce REST API Docs

Repository of documentation REST API WooCommerce.

This project is based on Slate.

Usage

Updating and building the docs

The docs for the latest version of the REST API (v3) are in source/includes/wp-api-v3. Each section of the docs has its own Markdown file. Once you have made changes, you can generate the docs locally with the following:

./build.sh

After the build script has finished, the generated docs can be found in the build directory. Open the index.html file in your browser to view the local version of the docs site.

Deploying the docs

When you merge a PR to the trunk branch of this repository, a workflow runs that will automatically deploy the generated docs to the gh-pages branch. However, you can also deploy manually with the following:

./deploy.sh