Install Page Builder example modules

Learning by example is one of the best ways to absorb the knowledge you need when learning new development tasks. We take that approach to heart and have tried to provide several example modules that focus on different areas of Page Builder development.

The Page Builder team members created these modules for educational purposes. They are not fully tested or guaranteed to work perfectly. However, we do our best to improve these examples and keep them updated with the latest releases of Page Builder.

You can find all our existing Page Builder examples in the https://github.com/magento-devdocs/pagebuilder-examples repo on GitHub. The repo contains two types of example modules:

  • Extension modules
  • Custom modules

Extension modules

Extension modules are extensions of Page Builder’s existing modules. Extending an existing module is often the best way to introduce new functionality to Page Builder. Our current extension modules are described here:

Custom modules

Custom modules create new content types for Page Builder. Creating a new content type is required when you want to introduce a completely new type of content structure to Page Builder. Our current custom modules are described here:

  • Custom Quote — This module shows you how to create a content type for a customer testimonial. This is the completed Quote module featured in the documentation tutorial: Creating content types. Created by Bruce Denham.

  • Custom Homepage Grid — This module shows you how to create a content type that recreates the layout of the Magento Luma-themed home page using a grid structure with grid items. Created by Dave Macaulay.

  • Custom FAQ — This module shows you how to create a content type for an FAQ page that uses an accordion for the questions and answers. Created by Igor Melnikov.

Installing the example modules

Use the instructions from the examples repo, found here: https://github.com/magento-devdocs/pagebuilder-examples#installing-the-example-modules.