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 Update issue template to ask for screenshots/video Nov 2, 2017
bin Framework: Introduce the data module (#3832) Dec 18, 2017
blocks Fix category in implementation of random image block Dec 28, 2017
components Refactor `PostSchedule` to make calendar/clock available as components ( Dec 27, 2017
data Data Module: Restrict the state access to the module registering the … Dec 20, 2017
date Framework: Upgrade ESLint dependencies Oct 27, 2017
docker Setup Local Dev environment using dockere Oct 31, 2017
docs Block API: Adding a description property to the block API Dec 28, 2017
editor Mobile: Enhance the redux mobile enhancer to use the MediaQueries API Dec 28, 2017
element Merge pull request #3827 from WordPress/update/component-filters-as-hoc Dec 12, 2017
i18n i18n: Support string concatenation in translate function Sep 4, 2017
languages Remove .pot file again (#646) May 4, 2017
lib TinyMCE: Switch the TinyMCE CDN Dec 29, 2017
phpunit Refactor Reusable Blocks controller to use WP_REST_Posts_Controller Dec 22, 2017
test Framework: Introduce the data module (#3832) Dec 18, 2017
utils Implemented query panel in latest posts block. (#3198) Dec 14, 2017
vendor Install `phpcs` using Composer (#1022) Jun 6, 2017
.babelrc Framework: Move babel-plugin-lodash to production build only Aug 4, 2017
.editorconfig CS: Set composer.json to use 4-space indentation Aug 30, 2017
.eslintignore Don't lint cypress files Nov 27, 2017
.eslintrc.json Framework: Introduce the data module (#3832) Dec 18, 2017
.gitignore Try to fix Webpack config issue on Node 6 Dec 1, 2017
.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 Don't cache the `vendor` directory (#3837) Dec 7, 2017
CODE_OF_CONDUCT.md Adds in a Code of conduct Oct 7, 2017
CONTRIBUTING.md Docs: Move testing section from CONTRIBUTING.md to Testing Overview d… Dec 8, 2017
CONTRIBUTORS.md Usability testing team props Dec 13, 2017
LICENSE.md Update `LICENSE.md` with WordPress Core Licensing Jun 28, 2017
README.md Change handbook links to the new wp.org URL (#3848) Dec 7, 2017
TESTS.md Add tests file. Mar 17, 2017
codecov.yml Framework: Disable codecov commenting Dec 2, 2017
composer.json Improved composer.json file (#1229) Dec 9, 2017
composer.lock Improved composer.json file (#1229) Dec 9, 2017
cypress.json Tests: Disable secyrity in Chrome when running e2e to fix CI tests Oct 31, 2017
gutenberg.php Remove unused variable from the_gutenberg_project function Dec 22, 2017
package-lock.json Update node-sass to v4.7.2 (#4200) Dec 29, 2017
package.json Update node-sass to v4.7.2 (#4200) Dec 29, 2017
phpcs.xml.dist PHPCS improvements (#2914) Oct 11, 2017
phpunit.xml.dist Setup server side unit tests (#617) May 10, 2017
post-content.js Blocks: Add the missing alignments classNames to the Cover Image Bloc… Dec 20, 2017
webpack.config.js Framework: Introduce the data module (#3832) Dec 18, 2017

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 remove 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 metaboxes 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