Printing since 1440. Development hub for the editor focus in core. Beta plugin is available from the official WordPress repository.
JavaScript PHP HTML CSS Shell
Switch branches/tags
Permalink
Failed to load latest commit information.
.github Add a link to Hacker One in the GitHub issue template (#4654) Jan 24, 2018
bin Build: Consolidate module build JS, CSS, map inclusion (#4957) Feb 9, 2018
blocks Blocks: Move filter for registering block types before validation hap… Feb 19, 2018
components Components: Remove Popover isOpen prop, render by presence (#5015) Feb 13, 2018
data Framework: Adding a deprecation helper (#5069) Feb 19, 2018
date JSDoc: prefer `@return` over `@retuns` (#4853) Feb 6, 2018
docs Implemented mechanism to allow themes to disable custom colors; (#4991) Feb 16, 2018
edit-post Block List: Extract copy, scroll-into-view logic to separate non-visu… Feb 14, 2018
editor Merge pull request #5112 from WordPress/fix/focus-bubbling-firefox Feb 16, 2018
element Element / Block API: Add RawHTML component, drop support for HTML str… Feb 6, 2018
i18n JSDoc: prefer `@return` over `@retuns` (#4853) Feb 6, 2018
languages Remove .pot file again (#646) May 4, 2017
lib Framework: Adding a deprecation helper (#5069) Feb 19, 2018
phpunit Framework: Strip comment demarcations in content filtering (#5042) Feb 15, 2018
test Replace the side inserter by an inserter with shortcuts on empty para… Feb 13, 2018
utils Framework: Adding a deprecation helper (#5069) Feb 19, 2018
vendor Install `phpcs` using Composer (#1022) Jun 6, 2017
.editorconfig Use tabs for indentation in build tools JSON files per WP Coding Stan… Jan 12, 2018
.eslintignore Don't lint cypress files Nov 27, 2017
.eslintrc.json Effects: Restore new post setup as non-dirtying change (#4836) Feb 7, 2018
.gitignore Release: Adding the i18n messages to the built plugin Feb 8, 2018
.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
.travis.yml Disable Travis branch builds except for `master` (#4651) Jan 24, 2018
CODE_OF_CONDUCT.md Adds in a Code of conduct Oct 7, 2017
CONTRIBUTING.md Add the first version of Repository Management (#4739) Feb 13, 2018
CONTRIBUTORS.md Add Cloud887 Jan 26, 2018
LICENSE.md Update copyright year to 2018 in license.md (#4511) Jan 16, 2018
README.md Add "Code is Poetry" footer Feb 13, 2018
SECURITY.md Use HTTPS for Hacker One URL (#4655) Jan 24, 2018
TESTS.md Add tests file. Mar 17, 2017
codecov.yml Framework: Disable codecov commenting Dec 2, 2017
composer.json Improve the build scripts (#4465) Jan 17, 2018
composer.lock Use tabs for indentation in build tools JSON files per WP Coding Stan… Jan 12, 2018
cypress.json Improve the build scripts (#4465) Jan 17, 2018
docker-compose.yml Use docker-compose for all Docker commands (#4592) Jan 19, 2018
gutenberg.php Update version to 2.2.0. (#5108) Feb 16, 2018
package-lock.json Update version to 2.2.0. (#5108) Feb 16, 2018
package.json Update version to 2.2.0. (#5108) Feb 16, 2018
phpcs.xml.dist PHPCS improvements (#2914) Oct 11, 2017
phpunit.xml.dist Setup server side unit tests (#617) May 10, 2017
post-content.js Fix post-content validation Jan 23, 2018
webpack.config.js Build: Assign `edit-post` global as `wp.editPost` (#4966) Feb 12, 2018

README.md

Gutenberg

Build Status Coverage

Printing since 1440.

Gutenberg editing

This is the development hub for the editor focus in core. Gutenberg is the project name. If you want to use the latest release with your WordPress, download Gutenberg from the WordPress.org plugins repository. Conversations and discussions take place in #core-editor on the core WordPress Slack.

Discover more about the project here.

Gutenberg is more than an editor. While the editor is the focus right now, the project will ultimately impact the entire publishing experience including customization (the next focus area).

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 from other systems is that it allows you to create as rich a post layout as you can imagine -- but only if you know HTML and CSS and build your own custom theme. By thinking of the editor as a tool to let you write rich posts and create beautiful layouts, we can transform WordPress into something users love, as opposed something they pick it because it's what everyone else uses.

Gutenberg looks at the editor as more than a content field, revisiting a layout that has been largely unchanged for almost a decade. This allows us 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 we add that on top of the existing interface, it would add complexity, as opposed to removing it.
  2. By revisiting the interface, we can modernize the writing, editing, and publishing experience, with usability and simplicity in mind, benefitting both new and casual users.
  3. 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. Considering the whole interface lays a solid foundation for the next focus, full site customization.
  5. Looking at the full editor screen also gives us 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 to an About page to automatically display a picture, name, and bio. A whole universe of plugins that all extend WordPress in the same way. 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 backwards 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. 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 for stages two and three, planned for the next year, to go beyond the post into page templates and ultimately, full site customization.

Gutenberg is a big change, and 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.

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.