Giter VIP home page Giter VIP logo

gutenberg-extensibility-workshop's Introduction

Gutenberg Extensibility Workshop

This repository contains examples of Gutenberg Extensibility Patterns. It's organized as a WordPress plugin you can install and activate to play with the different patterns exposed.

Plugin Extensibility Patterns (ES6)

It's composed of a sequential list of patterns you can enable one by one. Each pattern is organized like this:

  • A php file in lib/XX-pattern-name.php to enqueue the different scripts/stylesheets required for this pattern.
  • A folder in scripts/XX-pattern-name containing the JavaScript files and CSS and SASS stylesheets required for the pattern.
  • Each example is implemented in ES5 + CSS without requiring any built step but examples also include an ESnext + SASS equivalement implementation.
  • Running the build process ( npm run build ) generates a JavaScript bundle file scripts/XX-pattern-name/build/index.js and a stylesheet file scripts/XX-pattern-name/build/style.css if needed.
  • By default the plugin loads the ES5 + CSS version of each example, make sure to update the URL of the stylesheets/scripts used in the lib/XX-pattern-name.php file if you want to switch to the built versions.

Usage

  • Copy this repository to the wp-content/plugins/gew/ folder in your WordPress installation.
  • navigate to this folder using a terminal and run npm install && npm run build.

you can run npm run dev if you want to make updates to the script files and regenerate the built files automatically.

You can choose which pattern to enable/disable in your plugin by opening the gutenberg-extensibility-workshop.php file and comment/uncomment the corresponding pattern file.

Theme Extensibility

To demonstrate theme extensibility patterns, the repository contains a light theme optimized for Gutenberg Extensibility Patterns. You can install this theme by copying the theme folder in this repository to the wp-content/themes/gew/ folder in your WordPress installation.

gutenberg-extensibility-workshop's People

Contributors

aduth avatar ajitbohra avatar gziolo avatar jblz avatar jorgefilipecosta avatar mkaz avatar youknowriad avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.