Skip to content
The Block Editor project for WordPress and beyond. Plugin is available from the official repository.
Branch: master
Clone or download
mkaz Update links to new handbook (#15714)
* Update link to Block Editor handbook

* Update Documentation link in plugin to handbook

* Update links to new handbook location

* Switch to relative links
Latest commit d1cc70a May 20, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Add @daniloercoli and @SergioEstevao as RichText CODEOWNERS (#15681) May 16, 2019
assets/stylesheets Fix focus color contrast (#15544) May 10, 2019
bin Fixes update-readme script (#15679) May 16, 2019
docs RichText: stabilize onSplit (#14765) May 18, 2019
lib Add widget-areas endpoint (#15015) May 16, 2019
packages Update links to new handbook (#15714) May 20, 2019
phpunit Add preload paths for autosaves (#15067) May 4, 2019
playground Fix: Block movers don't appear on the playground and on the widgets p… May 6, 2019
test Remove (non-special) comment nodes when pasting content (#15557) May 14, 2019
vendor Install `phpcs` using Composer (#1022) Jun 6, 2017
.browserslistrc Build: using a postcss plugin to generate the admin-schemes styles (#… May 15, 2018
.editorconfig chore: Update `.editorconfig` to match WordPress' upstream Jan 12, 2018
.eslintignore Tests: Extract e2e test utils to their own package (#13228) Jan 15, 2019
.eslintrc.js Update to Babel 7.4 and core-js 3 (#15139) Apr 30, 2019
.gitignore Try implementing a built-in Gutenberg playground (#14497) Mar 25, 2019
.jshintignore Add .jshintignore to ignore all since eslint is employed May 25, 2017
.npmrc Framework: Configure NPM to save exact versions Aug 25, 2017
.nvmrc Framework: Bump recommended Node version to active LTS Nov 1, 2017
.stylelintrc.json Add stylelint for SCSS linting (#8647) Aug 8, 2018
.travis.yml Builld Tooling: Skip Chromium download in Travis by default (#15712) May 20, 2019
CODE_OF_CONDUCT.md Adds in a Code of conduct Oct 7, 2017
CONTRIBUTING.md Rename and link to Block Editor Handbook (#15656) May 15, 2019
CONTRIBUTORS.md Add @melchoyce @sarahmonster and @kjellr to CONTRIBUTORS.md (#15700) May 17, 2019
LICENSE.md Update License Year (#13145) Jan 1, 2019
README.md Update links to new handbook (#15714) May 20, 2019
SECURITY.md Use HTTPS for Hacker One URL (#4655) Jan 24, 2018
babel.config.js Block library: Try to use Babel plugins to inline block.json metadata ( Apr 2, 2019
composer.json Show lint errors when there are lint problems (#9661) Sep 13, 2018
composer.lock Upgrade WPCS to 1.0.0 (#9065) Aug 18, 2018
docker-compose-localdev.yml Allow access to the WordPress installation if DOCKER_ENV=localwpdev (#… Aug 10, 2018
docker-compose.yml Disable SCRIPT_DEBUG for local e2e tests run (#14638) Mar 26, 2019
gutenberg.php Update links to new handbook (#15714) May 20, 2019
jsconfig.json Tests: Extract e2e test utils to their own package (#13228) Jan 15, 2019
lerna.json Add changelog files back to the ingored changes by Lerna Nov 9, 2018
package-lock.json Custom Template Path Webpack Plugin: Rewrite as CommonJS (#15709) May 20, 2019
package.json Build Tooling: Remove WebpackRTLPlugin (#15711) May 17, 2019
phpcs.xml.dist Blocks: Re-register core blocks via build copy prefixing (#13521) Mar 25, 2019
phpunit.xml.dist Setup server side unit tests (#617) May 10, 2017
post-content.php Add nested blocks inside cover block (#13822) Mar 7, 2019
webpack.config.js Build Tooling: Remove WebpackRTLPlugin (#15711) May 17, 2019

README.md

Gutenberg

Build Status lerna

Screenshot of the Gutenberg Editor, editing a post in WordPress

This repo is the development hub for the editor focus in WordPress Core. Gutenberg is the project name.

Getting started

Gutenberg is more than an editor. While the project is currently focused on building the new editor for WordPress, it doesn't end there. This lays the groundwork for a new model for WordPress Core that will ultimately impact the entire publishing experience of the platform.

Editing focus

The editor will create a new page- and post-building experience that makes writing rich posts effortless, and has “blocks” to make it easy what today might take shortcodes, custom HTML, or “mystery meat” embed discovery.

— Matt Mullenweg

One thing that sets WordPress apart is that it allows you to create a post layout that's as rich as you can imagine—but only if you can build your own custom theme with HTML and CSS. By thinking of the editor as a tool that allows you to write rich posts and create beautiful layouts, we can transform WordPress into something users love, as opposed to something they choose because it happens to be what everyone else uses.

Gutenberg is a new way forward. It looks at the editor as more than a content field, revisiting a layout that has been largely unchanged for almost a decade. This project allows The WordPress Project to holistically design a modern editing experience and build a foundation for things to come.

Here's why we're looking at the whole editing screen, as opposed to just the content field:

  1. The block unifies multiple interfaces. If Gutenberg added blocks on top of the existing interface, it would add complexity, as opposed to removing it.
  2. Simplified (and enhanced) editing. By revisiting the interface, Gutenberg can modernize the writing, editing, and publishing experience, with usability and simplicity in mind, benefitting both new and casual users.
  3. Better interface usability. When singular block interface takes center stage, it demonstrates a clear path forward for developers to create premium blocks, superior to both shortcodes and widgets.
  4. A fresh look at content creation. Considering the whole interface lays a solid foundation for the next focus: full site customization.
  5. Modern tooling. Looking at the full editor screen also gives WordPress the opportunity to drastically modernize the foundation, and take steps towards a more fluid and JavaScript-powered future that fully leverages the WordPress REST API.

Writing in Gutenberg 1.6

Blocks

Blocks are the unifying evolution of what is now covered, in different ways, by shortcodes, embeds, widgets, post formats, custom post types, theme options, meta-boxes, and other formatting elements. They embrace the breadth of functionality WordPress is capable of, with the clarity of a consistent user experience.

Imagine a custom employee block that a client can drag onto an About page to automatically display a picture, name, and bio of all the employees. Imagine a whole universe of plugins just as flexible, all extending WordPress in the same way. Imagine simplified menus and widgets. Users who can instantly understand and use WordPress—and 90% of plugins. This will allow you to easily compose beautiful posts like this example.

Check out the FAQ for answers to the most common questions about the project.

Compatibility

Posts are backward compatible, and shortcodes will still work. We are continuously exploring how highly-tailored meta boxes can be accommodated, and are looking at solutions ranging from a plugin to disable Gutenberg to automatically detecting whether to load Gutenberg or not. While we want to make sure the new editing experience from writing to publishing is user-friendly, we’re committed to finding a good solution for highly-tailored existing sites.

The stages of Gutenberg

Gutenberg has three planned stages.

  1. The first, aimed for inclusion in WordPress 5.0, focuses on the post editing experience and the implementation of blocks. This initial phase focuses on a content-first approach. The use of blocks, as detailed above, allows you to focus on how your content will look without the distraction of other configuration options. This ultimately will help all users present their content in a way that is engaging, direct, and visual. These foundational elements will pave the way forward.
  2. Planned for 2019, The second stage focuses on overhauling The Customizer and page templates.
  3. Ultimately, full site customization will be possible.

Gutenberg is a big change. There will be ways to ensure that existing functionality (like shortcodes and meta-boxes) continue to work while allowing developers the time and paths to transition effectively. Ultimately, it will open new opportunities for plugin and theme developers to better serve users through a more engaging and visual experience that takes advantage of a toolset supported by core.

Get involved

We’re calling this editor project "Gutenberg" because it's a big undertaking. We are working on it every day in GitHub, and we'd love your help building it. You’re also welcome to give feedback, the easiest is to join us in our Slack channel, #core-editor. A weekly meeting is held in the Slack channel on Wednesdays at 13:00 UTC.

Contributors

Gutenberg is built by many contributors and volunteers. Please see the full list in CONTRIBUTORS.md.

How You Can Contribute

Please see CONTRIBUTING.md.

Further Reading



Code is Poetry.

You can’t perform that action at this time.