vonloxx / gutenberg

Frupal Gutenberg

CONTENTS OF THIS FILE

• Introduction
• Requirements
• Installation
• Configuration
• Maintainers

INTRODUCTION

• Drupal Gutenberg brings the powerful content editing experience of Gutenberg to Drupal.

• Drupal + Gutenberg is a powerful combo. Drupal 8 is a rock solid CMS framework packed with powerful admin features. Our only complaint? Drupal 8 is missing a modern UI for rich content creation. Let’s change this!

• More functionality wrapped in a smooth UI. Hundreds of hours with user testing. Decoupled. React.js. Clean output. Open source.

• Gutenberg on GitHub

• For a full description: https://www.drupal.org/project/gutenberg

• Issue queue for Gutenberg: https://www.drupal.org/project/issues/gutenberg

• Also check Gutenberg-JS, a stand-alone Gutenberg editor for your custom sites or web apps.

REQUIREMENTS

No specific requirements.

INSTALLATION

• Install normally as other modules are installed. For Support: https://www.drupal.org/docs/8/extending-drupal/installing-contributed-modules

CONFIGURATION

• To test the module, simply download it from the Drupal Gutenberg project page and enable it.

• Then go to any content type edit page and enable Gutenberg Experience.

DEVELOPMENT

NodeJS 8.11+ and NPM 6.0+ are required. Alternatively Yarn 1.6+ can be used.

• npm install
• Watching file while developing: npm start
• Build: npm run build

For custom block development, check the example_block sub-module.

Updating WordPress Gutenberg Packages

This module uses the compiled JS packages from WordPress Gutenberg. Basically we just need to copy the files to vendor/gutenberg.

Steps to update WordPress Gutenberg packages:

• There's two options to get the WordPress Gutenberg packages:
  • Option 1:
    • Download a release from Github ex: https://github.com/WordPress/gutenberg/releases/tag/v8.0.0
    • Unzip the file.
  • Option 2:
    • Git clone WordPress Gutenberg repository https://github.com/WordPress/gutenberg
    • Run npm install and npm run build - this will create a new subfolder build with all compiled WordPress Gutenberg packages
• Copy all folders from build folder to the module's folder vendor\gutenberg (remove the old package folders before copy)
• At module's folder, go to scripts and run php gutenberg-dependencies.php - this will regenerate the gutenberg.libraries.yml config file

Vendor packages

• React: Build file, project page
• React DOM: Build file, project page
• Lodash: Build file, project page
• MomentJS: Build file, project page
• Regenerator Runtime: Build file, project page
• G-Media-Attributes: Build file, project page
• TinyMCE: Build package, project page
• Gutenberg: Project page Drupal Gutenberg relies on some JSON files (dependencies tree) generated when building Gutenberg. So, to get the correct files, the git repository must be cloned and built.

MAINTAINERS

Current maintainers:

• Marco Fernandes (marcofernandes) - https://www.drupal.org/u/marcofernandes
• Thor Andre Gretland (thorandre) - https://www.drupal.org/u/thorandre
• Roberto Ornelas (roborn) - https://www.drupal.org/u/roborn