Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/somoscuatro/homebrew-wp-blocks-library
Install WordPress blocks from somoscuatro library.
https://github.com/somoscuatro/homebrew-wp-blocks-library
block-library brew homebrew-formula wordpress wordpress-blocks wordpress-library wordpress-ui
Last synced: 24 days ago
JSON representation
Install WordPress blocks from somoscuatro library.
- Host: GitHub
- URL: https://github.com/somoscuatro/homebrew-wp-blocks-library
- Owner: somoscuatro
- License: other
- Created: 2024-06-06T18:35:37.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-06-06T18:59:32.000Z (5 months ago)
- Last Synced: 2024-10-04T21:43:16.976Z (about 1 month ago)
- Topics: block-library, brew, homebrew-formula, wordpress, wordpress-blocks, wordpress-library, wordpress-ui
- Language: Shell
- Homepage: https://somoscuatro.es
- Size: 4.88 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# WordPress Blocks Library
This tool downloads ACF Gutenberg Blocks and Components from the [somoscuatro
blocks library](https://github.com/somoscuatro/wp-blocks-library).
Our library contains a collection of blocks that can be reused in your theme,
such as hero, CTA, accordions, etc. Components are reusable templates that can
be used by multiple blocks or templates (e.g., image, button, etc.).
## Prerequisites
Our blocks are designed to work with themes that follow the structure of [our
starter theme](https://github.com/somoscuatro/sc-starter-theme).
You can scaffold a new WordPress project that uses our starter theme by using
[our `wp-project-scaffold` Homebrew
command](https://github.com/somoscuatro/homebrew-wp-project-scaffold).
## Installation
To install the WordPress Blocks Library, follow these steps:
1. Add the custom Homebrew tap:
```shell
brew tap somoscuatro/homebrew-wp-blocks-library
```
2. Install the `wp-blocks-library` tool via Homebrew:
```shell
brew install wp-blocks-library
```
## Usage
Navigate to your theme folder and run the following command to install a block:
```shell
wp-blocks-library add block [block-name]
```
This will automatically install the block in your theme's `src/blocks` folder
and install all dependencies needed by the block.
You can also install components by running:
```shell
wp-blocks-library add component [component-name]
```
To remove a block, use:
```shell
wp-blocks-library remove block [block-name]
```
And to remove a component, use:
```shell
wp-blocks-library remove component [component-name]
```
Please note that when you remove a block, dependencies are not removed
automatically to avoid deleting dependencies needed by other blocks. You can
manually remove the component with the command mentioned above.
## How to Contribute
Any kind of contribution is very welcome!
Please be sure to read our [Code of
Conduct](https://raw.githubusercontent.com/somoscuatro/homebrew-wp-blocks-library/main/CODE_OF_CONDUCT.md).
If you notice something wrong please open an issue or create a Pull Request or
just send an email to [[email protected]](mailto:[email protected]). If you
want to warn us about an important security vulnerability, please read our
Security Policy.
## License
All code is released under MIT license version. For more information, please
refer to
[LICENSE.md](https://raw.githubusercontent.com/somoscuatro/homebrew-wp-blocks-library/main/LICENSE.md)