gutenberg README

The project's README from github.com/WordPress/gutenberg. As one markdown file: README.md.

Gutenberg

End-to-End Tests Static Analysis (Linting, License, Type checks...) Unit Tests Create Block

Storybook Badge

lerna

Screenshot of the Gutenberg Editor, editing a post in WordPress

Welcome to the development hub for the WordPress Gutenberg project!

"Gutenberg" is a codename for a whole new paradigm in WordPress site building and publishing that aims to revolutionize the entire publishing experience as much as Gutenberg did the printed word. Right now, the project is in the second phase of a four-phase process that will touch every piece of WordPress -- Editing, Customization, Collaboration (which includes Real-time collaboration, Asynchronous collaboration, Publishing flows, Post revisions interface, Admin design, Library), and Multilingual -- and is focused on a new editing experience, the block editor.

The block editor introduces a modular approach to pages and posts: each piece of content in the editor, from a paragraph to an image gallery to a headline, is its own block. And just like physical blocks, WordPress blocks can be added, arranged, and rearranged, allowing WordPress users to create media-rich pages in a visually intuitive way -- and without workarounds like shortcodes or custom HTML.

The block editor first became available in December 2018, and we're still hard at work refining the experience, creating more and better blocks, and laying the groundwork for the next three phases of work. The Gutenberg plugin gives you the latest version of the block editor, so you can join us in testing bleeding-edge features, start playing with blocks, and maybe get inspired to build your own.

Check out the Keeping up with Gutenberg Index.

Getting Started

Get hands-on: check out the block editor live demo to play with a test instance of the editor.

Using Gutenberg

Developing for Gutenberg

Extending and customizing is at the heart of the WordPress platform, this is no different for the Gutenberg project. The editor and future products can be extended by third-party developers using plugins.

Review the Quick Start Guide for the fastest way to get started extending the block editor. See the Block Editor Handbook for extensive tutorials, documentation, and API references. Also, check the WordPress Developer Blog for great articles about block development, among other topics.

Contribute to Gutenberg

Gutenberg is an open-source project and welcomes all contributors from code to design, and from documentation to triage. The project is built by many contributors and volunteers, and we'd love your help building it.

See the Contributors Handbook for all the details on how you can contribute.

To get up and running quickly with code contribution, see Getting Started With Code Contribution. Also check out the other resources available on the Code Contributions page.

In whichever way you wish to contribute, please be sure to read the Contributing Guidelines first.

As with all WordPress projects, we want to ensure a welcoming environment for everyone. With that in mind, all contributors are expected to follow our Code of Conduct.

Get Involved

You can join us in the #core-editor channel in Slack, see the WordPress Slack page for signup information; it is free to join.

License

WordPress is free software, and is released under the terms of the GNU General Public License version 2 or (at your option) any later version. See LICENSE.md for complete license.



Code is Poetry.

gutenberg (WordPress/gutenberg)

wordpress
Searching Database…

11.8K ·GitHub
What is this?Gutenberg is the block editor project for WordPress, replacing the old post editor with a modular system where every piece of content (paragraph, image, gallery, heading) is an editable block.
Is this a WordPress plugin or a core feature?It is a WordPress plugin that ships the latest, bleeding-edge version of the block editor, which eventually gets merged into WordPress core; this repo is the development hub for that editor.
How do I start using it on my site?Install the Gutenberg plugin from the wp-admin plugins page, or download it from the WordPress.org plugin repository.
Do I need anything besides WordPress to use the plugin?Just a WordPress site; for building the project yourself from source you need Node.js 24.18+ and npm 11.16+.
Is this stable enough for a production site?The plugin intentionally carries bleeding-edge, in-progress features still being refined, so it's ahead of what's in WordPress core and can be less stable.
Who is this repo really for?End users just install the plugin, but this repository is mainly aimed at developers who want to extend or build new blocks for the editor.
What project phase is Gutenberg currently in?It is in the second of four planned phases, following Editing, and moving toward Customization, Collaboration, and Multilingual support.
Can I build custom blocks for the editor?Yes, third-party developers can extend the editor with plugins and custom blocks, and the Block Editor Handbook provides tutorials and API references for this.
Where can I try the editor before installing it?There is a live demo of the block editor you can play with to test a sample instance before installing anything.
Creator
WordPress
Size
1.1 GB
Stars
11.8K
Age
9y
Commits · 90 Days