woocommerce/woocommerce-rest-api-docs
1
0
Fork 0
mirror of https://gh.wpcy.net/https://github.com/woocommerce/woocommerce-rest-api-docs.git synced 2026-04-24 04:42:50 +08:00
Code Issues Projects Packages Activity Actions
WooCommerce REST API Documentation http://woocommerce.github.io/woocommerce-rest-api-docs/
647 commits 6 branches 0 tags 4.6 MiB
Find a file
Exact
Brian Coords 9716c70548 Add markdown endpoints for AI coding agents 
Generate lightweight markdown versions of the API documentation that are
more suitable for AI coding agents and LLMs. The current HTML output is
~4.2MB which is heavy for agents to process.

- Add build-markdown.sh script that parses YAML front matter and
  concatenates includes into single markdown files
- Update deploy workflow to generate markdown after Slate build
- Output files: index.md, wp-api-v1.md, wp-api-v2.md

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-03-09 19:48:34 -07:00
.github/workflows Add markdown endpoints for AI coding agents 2026-03-09 19:48:34 -07:00
source Add wp_environment_type to system status documentation 2025-12-17 16:24:32 -06:00
.editorconfig Updated slate 2018-10-16 00:55:07 -03:00
.gitignore Updated slate 2018-10-16 00:55:07 -03:00
build-markdown.sh Add markdown endpoints for AI coding agents 2026-03-09 19:48:34 -07: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

README.md

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