Printing since 1440. Development hub for the editor focus in core. Beta plugin is available from the official WordPress repository.
JavaScript PHP CSS HTML Shell
Switch branches/tags
Clone or download
Permalink
Failed to load latest commit information.
.github Update issue templates to have 3 options May 9, 2018
bin Fix Typos (#7286) Jun 12, 2018
blocks Block API: Move useOnce to supports.useOnce (#7293) Jun 14, 2018
components Introduce `rendererPathWithAttributes()` for ServerSideRender (#7371) Jun 19, 2018
core-blocks Block List: Remove createInnerBlockList utility / context (#7192) Jun 20, 2018
docs Documentation: Generate Docs for the data module (#7264) Jun 19, 2018
edit-post Effects: Move trash post URL change to the BrowserUrl component (#7228) Jun 20, 2018
editor Block List: Remove createInnerBlockList utility / context (#7192) Jun 20, 2018
eslint Packages: Move data module to the package maintained by Lerna (#6828) May 30, 2018
languages Build: Include string extraction in production build (#5308) Mar 2, 2018
lib State: Trigger autosave as standard save for draft by current user (#… Jun 20, 2018
nux Add Show Tips toggle (#7163) Jun 19, 2018
packages Upgrade React 16.3.2 to React 16.4.1 (#7393) Jun 20, 2018
phpunit State: Trigger autosave as standard save for draft by current user (#… Jun 20, 2018
test State: Trigger autosave as standard save for draft by current user (#… Jun 20, 2018
utils Check allowed mime types before uploading media (#6968) Jun 19, 2018
vendor Install `phpcs` using Composer (#1022) Jun 6, 2017
viewport Element: Depreacate getWrapperDisplayName in favor of createHigherOrd… Apr 3, 2018
.browserslistrc Build: using a postcss plugin to generate the admin-schemes styles (#… May 15, 2018
.editorconfig Use tabs for indentation in build tools JSON files per WP Coding Stan… Jan 12, 2018
.eslintignore Testing: Add e2e tests for Plugins API (#7269) Jun 12, 2018
.eslintrc.js Add a new `@wordpress/api-request` package (#7018) Jun 8, 2018
.gitignore Testing: Add e2e tests for Plugins API (#7269) Jun 12, 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 Use npm v6 is the minimum required version (#6629) May 9, 2018
CODE_OF_CONDUCT.md Adds in a Code of conduct Oct 7, 2017
CONTRIBUTING.md Fix typos in code comments (#6904) May 23, 2018
CONTRIBUTORS.md Add snapshot test about `MoreMenu` component (#7338) Jun 20, 2018
LICENSE.md Update copyright year to 2018 in license.md (#4511) Jan 16, 2018
README.md Updating FAQ link in README.md (#7121) Jun 18, 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
docker-compose.yml Testing: Disable login screen autofocus (#6129) Apr 16, 2018
gutenberg.php Avoid loading Gutenberg assets in other admin pages (#7117) Jun 6, 2018
lerna.json Remove `%s` from Lerna publish message (#6827) May 18, 2018
package-lock.json Upgrade React 16.3.2 to React 16.4.1 (#7393) Jun 20, 2018
package.json Upgrade React 16.3.2 to React 16.4.1 (#7393) Jun 20, 2018
phpcs.xml.dist Add Server Side Render component and endpoint. (#5602) Apr 26, 2018
phpunit.xml.dist Setup server side unit tests (#617) May 10, 2017
post-content.js Blocks: Update demo content to avoid dirtying embed (#7379) Jun 19, 2018
webpack.config.js Packages: Move Plugins module to packages (#7235) Jun 20, 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. 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.