Ben Dwyer 0d7ec66c8b BCB: Fix PHP warnings 4 years ago
..
assets 5d05870ed8 Merge pull request #3704 from Automattic/fix/bcb-code-font-family 4 years ago
block-template-parts d2ce2a4e18 Bringing development work from working branch to trunk (#3608) 4 years ago
block-templates d2ce2a4e18 Bringing development work from working branch to trunk (#3608) 4 years ago
inc 4d49c82755 Fix color markup. 4 years ago
sass 5d05870ed8 Merge pull request #3704 from Automattic/fix/bcb-code-font-family 4 years ago
build.js d2ce2a4e18 Bringing development work from working branch to trunk (#3608) 4 years ago
experimental-theme.json 5d05870ed8 Merge pull request #3704 from Automattic/fix/bcb-code-font-family 4 years ago
functions.php 0d7ec66c8b BCB: Fix PHP warnings 4 years ago
index.php 9e8755c5e5 First Build of Blank Canvas Blocks 4 years ago
package-lock.json 6fa9460ee1 Blank Canvas Blocks: Update build script 4 years ago
package.json d2ce2a4e18 Bringing development work from working branch to trunk (#3608) 4 years ago
readme.md d6d5dea3f6 updated readme with child theme instructions (#3689) 4 years ago
screenshot.png 9e8755c5e5 First Build of Blank Canvas Blocks 4 years ago
style.css a2bed96c95 Add licensing information. 4 years ago

readme.md

=== Blank Canvas Blocks ===

Contributors: Automattic Requires at least: ? Tested up to: ? Requires PHP: ? License: GPLv2 or later License URI: http://www.gnu.org/licenses/gpl-2.0.html

An unopinionated 'Ponyfill' to fill the gaps between where Gutenberg IS and where Gutenberg is GOING.

== Description ==

The purpose of Blank Canvas Blocks is to provide a "ponyfill" that allows for 100% "configuration expression" of design. Any aspect of configurable design that Gutenberg does not yet take into account is expressed in theme.json 'custom' properties.

To use this theme assign it as the parent theme and then copy from this them to the child theme the theme.json file and fill out the details.

The goal is for the ponyfill styling to reflect what Gutenberg will style, from a given configuration, once that work is complete. But to offer that today, using simpler techniques that Gutenberg will use upon completion.

== Building a Block Child Theme ==

To build a BCB child theme follow these instructions:

  • Add a package.json, style.css and empty index.php files to your theme
  • Your child theme's theme.json file will be built by combining BCB's original theme.json file and your child's child-experimental-theme.json. That is the file where your configuration values live (you only want the values for variables that are different from the parent there). To generate the combined file, run npm run build from inside your theme's folder or run npm run build:child child-theme-slug from inside BCB's folder.
  • Extend the parent's templates that you want to customize or add new ones where needed following the template hierarchy.
  • Using npm run start will both watch changes inside the sass and assets folder and changes to the child-experimental-theme.json file.
  • Additionally, your child theme may want to unregister the block patterns and block styles defined by BCB.

== Building a Universal Child Theme ==

A Universal theme is a theme that works in Full Site Editing and in the Customizer. This is a concept that's still being explored so we don't have instructions to provide yet. If you are curious, you can visit the branch where we are developing Quadrat as a Universal Theme.