Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
woocommerce/plugins/woocommerce-blocks/README.md

41 lines
2.4 KiB
Markdown
Raw Normal View History

use consistent product name `WooCommerce Blocks` (https://github.com/woocommerce/woocommerce-blocks/pull/3567) * use consistent product name `WooCommerce Blocks: - readme.md title + update product vision paragraph - update references in readme.txt preamble - update in tests bootstrap message * add WCCOM/docs links front & centre in readme for convenience
2020-12-22 19:49:45 +00:00
# WooCommerce Blocks <!-- omit in toc -->
Update build process (https://github.com/woocommerce/woocommerce-blocks/pull/122) * Add api-fetch dependency * Remove compiled files from the repo * Update build process, remove grunt * Import CSS into block, as we now extract CSS via webpack to build * Update enqueue scripts to reflect new build locations * Detect if build files don’t exist, and instruct users to build project * Update readme with build instructions * Clarify where to run npm commands in info notice * Only enqueue our JS files if we know they exist * Clarify version compatibility between WC and WP 5.0
2018-11-13 19:12:32 +00:00
Updated Documentation
2023-12-10 05:42:59 +00:00
This is the client for WooCommerce + Gutenberg. This package serves as a space to iterate and explore new Blocks and updates to existing blocks for WooCommerce, and how WooCommerce might work with the block editor.
use consistent product name `WooCommerce Blocks` (https://github.com/woocommerce/woocommerce-blocks/pull/3567) * use consistent product name `WooCommerce Blocks: - readme.md title + update product vision paragraph - update references in readme.txt preamble - update in tests bootstrap message * add WCCOM/docs links front & centre in readme for convenience
2020-12-22 19:49:45 +00:00
Improve readme.txt with note about nature of feature plugin (https://github.com/woocommerce/woocommerce-blocks/pull/2553) * add improvements to readme.txt * some more tweaks to align with README.md * Fix up TOC * Remove errant “This.”
2020-05-25 13:39:21 +00:00
## Table of Contents <!-- omit in toc -->
Format Markdown files using wp-scripts (https://github.com/woocommerce/woocommerce-blocks/pull/6462) * Format Markdown files using Prettier * Format Markdown files using wp-scripts * Adjust MD linting
2022-06-09 12:43:17 +00:00
- [Documentation](#documentation)
- [Code Documentation](#code-documentation)
- [Getting started with block development](#getting-started-with-block-development)
- [Long-term vision](#long-term-vision)
Add "contributor" docs for developer tools, release processes (https://github.com/woocommerce/woocommerce-blocks/pull/504) * Docs: Add docs for npm scripts and the release process * Update readme to reflect project status * Add install instructions * Add a link to a previous PR for an example
2019-03-22 14:40:55 +00:00
link to docs.woocommerce.com from repo readme (https://github.com/woocommerce/woocommerce-blocks/pull/1749)
2020-02-17 10:49:36 +00:00
## Documentation
To find out more about the blocks and how to use them, [check out the documentation on WooCommerce.com](https://docs.woocommerce.com/document/woocommerce-blocks/).
Add "contributor" docs for developer tools, release processes (https://github.com/woocommerce/woocommerce-blocks/pull/504) * Docs: Add docs for npm scripts and the release process * Update readme to reflect project status * Add install instructions * Add a link to a previous PR for an example
2019-03-22 14:40:55 +00:00
If you want to see what we're working on for future versions, or want to help out, read on.
Initialize with readme
2018-02-13 17:32:11 +00:00
Improve readme.txt with note about nature of feature plugin (https://github.com/woocommerce/woocommerce-blocks/pull/2553) * add improvements to readme.txt * some more tweaks to align with README.md * Fix up TOC * Remove errant “This.”
2020-05-25 13:39:21 +00:00
### Code Documentation
Format Markdown files using wp-scripts (https://github.com/woocommerce/woocommerce-blocks/pull/6462) * Format Markdown files using Prettier * Format Markdown files using wp-scripts * Adjust MD linting
2022-06-09 12:43:17 +00:00
- [Blocks](./assets/js/blocks) - Documentation for specific Blocks.
- [Editor Components](assets/js/editor-components) - Shared components used in WooCommerce blocks for the editor (Gutenberg) UI.
- [WooCommerce Blocks Handbook](./docs) - Documentation for designers and developers on how to extend or contribute to blocks, and how internal developers should handle new releases.
Fix broken storybook link
2022-06-21 13:39:24 +00:00
- [WooCommerce Blocks Storybook](https://woocommerce.github.io/woocommerce-blocks/) - Contains a list and demo of components used in the plugin.
Improve readme.txt with note about nature of feature plugin (https://github.com/woocommerce/woocommerce-blocks/pull/2553) * add improvements to readme.txt * some more tweaks to align with README.md * Fix up TOC * Remove errant “This.”
2020-05-25 13:39:21 +00:00
Update and add documentation in READMEs (https://github.com/woocommerce/woocommerce-blocks/pull/551)
2019-05-09 14:45:09 +00:00
## Getting started with block development
Fix "Writing Your First Block Type" tutorial link in docs (https://github.com/woocommerce/woocommerce-blocks/pull/8231) Changed the URL of "Writing Your First Block Type" in doc from Gutenberg project to block development guide.
2023-01-18 17:04:20 +00:00
Run through the ["Writing Your First Block Type" tutorial](https://developer.wordpress.org/block-editor/how-to-guides/block-tutorial/writing-your-first-block-type/) for a quick course in block-building.
Update and add documentation in READMEs (https://github.com/woocommerce/woocommerce-blocks/pull/551)
2019-05-09 14:45:09 +00:00
For deeper dive, try looking at the [core blocks code,](https://github.com/WordPress/gutenberg/tree/master/packages/block-library/src) or see what [components are available.](https://github.com/WordPress/gutenberg/tree/master/packages/components/src)
Other useful docs to explore:
Update README.md Adding the vision to the readme so people know what this repo is for. :)
2018-02-27 20:54:30 +00:00
Re-organise docs and add WP update instructions (https://github.com/woocommerce/woocommerce-blocks/pull/1691) * Move coding guideline and release docs to subdirectories * Strip down contributing md to link to new docs * Create main readme file to act as TOC * Getting started and testing docs from contributing.md * WP update testing checklist and docs for woocommerce/woocommerce-blocks#1285 * Update docs/contributors/smoke-testing.md Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * link to svn doc * Link to docs from readme * Resolve feedback * More consistent $ usage Co-authored-by: Albert Juhé Lluveras <aljullu@gmail.com>
2020-01-31 12:48:11 +00:00
- [`InnerBlocks`](https://github.com/WordPress/gutenberg/blob/master/packages/block-editor/src/components/inner-blocks/README.md)
Update README.md
2023-07-27 09:29:39 +00:00
- [`apiFetch`](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-api-fetch/)
Re-organise docs and add WP update instructions (https://github.com/woocommerce/woocommerce-blocks/pull/1691) * Move coding guideline and release docs to subdirectories * Strip down contributing md to link to new docs * Create main readme file to act as TOC * Getting started and testing docs from contributing.md * WP update testing checklist and docs for woocommerce/woocommerce-blocks#1285 * Update docs/contributors/smoke-testing.md Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * link to svn doc * Link to docs from readme * Resolve feedback * More consistent $ usage Co-authored-by: Albert Juhé Lluveras <aljullu@gmail.com>
2020-01-31 12:48:11 +00:00
- [`@wordpress/editor`](https://github.com/WordPress/gutenberg/blob/master/packages/editor/README.md)
Fix "Writing Your First Block Type" tutorial link in docs (https://github.com/woocommerce/woocommerce-blocks/pull/8231) Changed the URL of "Writing Your First Block Type" in doc from Gutenberg project to block development guide.
2023-01-18 17:04:20 +00:00
- [`@wordpress/create-block`](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-create-block/)
Update README.md Adding the vision to the readme so people know what this repo is for. :)
2018-02-27 20:54:30 +00:00
use consistent product name `WooCommerce Blocks` (https://github.com/woocommerce/woocommerce-blocks/pull/3567) * use consistent product name `WooCommerce Blocks: - readme.md title + update product vision paragraph - update references in readme.txt preamble - update in tests bootstrap message * add WCCOM/docs links front & centre in readme for convenience
2020-12-22 19:49:45 +00:00
## Long-term vision
Update README.md Adding the vision to the readme so people know what this repo is for. :)
2018-02-27 20:54:30 +00:00
fix typo (https://github.com/woocommerce/woocommerce-blocks/pull/11374)
2023-10-23 08:56:19 +00:00
WooCommerce Blocks are the easiest, most flexible way to build your store's user interface and showcase your products.