woocommerce/plugins/woocommerce-blocks/docs
Roy Ho d6a48ecaf5
Add autogeneration of block list reference documentation (#46479)
* Add autogeneration of block list reference documentation

* Fix typo

* Revert this change

* Fix typo

* Add changefile(s) from automation for the following project(s): woocommerce-blocks

* Add blanklines to surrounding markdown headings

* Generate blocks references markdown

* Add space to header markdown

* Add ancestor information

* Use native Object.keys instead of lodash

* Remove the use of fast-glob

* Revert pnpm lock file changes

* Update plugins/woocommerce-blocks/bin/gen-block-list-doc.js

Co-authored-by: Karol Manijak <20098064+kmanijak@users.noreply.github.com>

* Update doc title

---------

Co-authored-by: github-actions <github-actions@github.com>
Co-authored-by: Karol Manijak <20098064+kmanijak@users.noreply.github.com>
2024-04-25 06:03:41 -07:00
..
block-references Add autogeneration of block list reference documentation (#46479) 2024-04-25 06:03:41 -07:00
contributors Update Woo.com references to WooCommerce.com (#46259) 2024-04-09 09:50:15 +01:00
designers/theming Update Woo.com references to WooCommerce.com (#46259) 2024-04-09 09:50:15 +01:00
examples Format Markdown files using wp-scripts (https://github.com/woocommerce/woocommerce-blocks/pull/6462) 2022-06-09 14:43:17 +02:00
internal-developers Fix broken links from issue #46336 (#46381) 2024-04-15 14:30:37 +02:00
third-party-developers/extensibility Add hooks when reading and writing additional fields (#46870) 2024-04-24 17:38:15 +02:00
README.md Add autogeneration of block list reference documentation (#46479) 2024-04-25 06:03:41 -07:00

README.md

WooCommerce Blocks Handbook

Table of Contents

The WooCommerce Blocks Handbook provides documentation for designers and developers on how to extend or contribute to blocks, and how internal developers should handle new releases.

Contributors

Want to contribute to the WooCommerce Blocks plugin? The following documents offer information that can help you get started.

Internal developers

Are you an internal developer? The following documents offer information about the different blocks, the Block Client APIs, the Store API, the templates and the testing process.

Third-party developers

Are you a third-party developer? The following documents explain how to extend the WooCommerce Blocks plugin with your custom extension.

Designers

Are you a designer? The following documents explain how to apply design-changes to the WooCommerce Blocks plugin.

Block References

Developer Resources

Tools

  • @woocommerce/extend-cart-checkout-block This is a template to be used with @wordpress/create-block to create a WooCommerce Blocks extension starting point. It also showcases how to use some extensibility points, e.g. registering an inner block in the Checkout Block, applying filters to certain texts such as the place order button, using Slot/Fill and how to change the behaviour of the Store API.

Articles

The following posts from developer.woo.com provide deeper insights into the WooCommerce Blocks development.

Tutorials

The following tutorials from developer.woo.com help you with extending the WooCommerce Blocks plugin.


We're hiring! Come work with us!

🐞 Found a mistake, or have a suggestion? Leave feedback about this document here.