Skip to content
WordPress "Gutenberg" Blocks Boilerplate
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
.gitattributes
.gitignore
LICENSE
README.md
index.php
package.json

README.md

them.es WordPress Blocks

them.es WordPress Blocks is a WordPress "Gutenberg" blocks boilerplate which can be included in a theme.

What's included?

  • Gutenberg blocks configuration tested in WordPress v5.1+
  • NPM configuration
  • ESNext
  • Support for Editor color palettes
  • Support for a category where all custom blocks can be organized
  • A simple "Hello world" block implementation is included
  • Optional: Easily add more blocks

Setup

  • Prerequisites: Node.js (NPM) needs to be installed on your system
  • Download the source code to a new directory (e.g. /blocks) in your WordPress theme
  • Add the following code snippet to functions.php in your theme
$theme_blocks = __DIR__ . '/blocks/index.php';
if ( is_readable( $theme_blocks ) ) :
	require_once $theme_blocks;
endif;
  • Open /blocks in Terminal and install the required Node.js dependencies
  • $ npm install
  • A simple Hello world block implementation is included to get you started. More examples can be found in the official Gutenberg examples repository
  • You can easily include additional blocks by duplicating /src/block# and referencing the new block(s) in /src/index.js
  • Run the start script
  • $ npm run start
  • Develop the block(s) by modifying /src/block#/index.js - the official Gutenberg Handbook may help you learn how to build blocks
  • When you're done run the build script to create a minified version of your blocks
  • $ npm run build
  • Now you can test the block(s) in the WordPress Editor

Technology

Copyright & License

Code and Documentation © them.es

Code released under GPLv2+

You can’t perform that action at this time.