gutenberg README

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

Gutenberg

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

Download: To use the latest release of the Gutenberg plugin on your WordPress site: install from the plugins page in wp-admin, or download from the WordPress.org plugins repository.
User Documentation: See the WordPress Editor documentation for detailed docs on using the editor as an author creating posts and pages.
User Support: If you have run into an issue, you should check the Support Forums first. The forums are a great place to get help. If you have a bug to report, please submit it to the Gutenberg repository. Please search prior to creating a new bug to confirm it's not a duplicate.

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.

Searching Database…

11.8K ·GitHub

这是什么？

Gutenberg 是 WordPress 的区块编辑器项目，它用模块化的区块系统取代了旧的文章编辑器，每一块内容（段落、图片、图库、标题）都是可以编辑的区块。

这是 WordPress 插件，还是核心功能？

它是一个 WordPress 插件，提供最新的、前沿的区块编辑器版本，这些功能最终会并入 WordPress 核心；本代码仓库是该编辑器的主要开发中心。

我该怎么在网站上开始使用？

从 wp-admin 插件页面安装 Gutenberg 插件，或者从 WordPress.org 插件仓库下载。

除了 WordPress，使用这个插件还需要别的东西吗？

只需要一个 WordPress 网站即可；如果想自己从源代码构建项目，则需要 Node.js 24.18+ 和 npm 11.16+。

这个插件稳定到可以用在正式站点上吗？

这个插件有意包含一些前沿的、仍在打磨中的功能，所以它比 WordPress 核心更超前，稳定性可能稍差。

这个代码仓库到底是给谁用的？

普通用户只需安装插件即可；但这个仓库主要面向开发者，适合想要扩展编辑器或开发新区块的人。

Gutenberg 目前处于哪个项目阶段？

目前处于计划中的四个阶段的第二阶段，在编辑阶段之后，正朝着定制、协作和多语言支持迈进。

我能为编辑器开发自定义区块吗？

可以，第三方开发者可以通过插件和自定义区块来扩展编辑器，Block Editor Handbook 提供了相关的教程和 API 参考。

安装前能在哪里试用这个编辑器？

你可以在一个实时演示中体验区块编辑器，在示例站点上测试，无需安装任何东西。

What are similar projects?

WordPress, Neofollower-SMM-Reseller-API-for-Woocommerce, woocommerce, wordpress-develop, october, Kooboo, decap-cms, Core-Framework

Which topics is it in?

wordpress-plugin, content-management-system, wordpress, cms, gplv2, php, editor, plugin, web-app, npm, server, typescript

Creator: WordPress
Size: 1.1 GB
Stars: 11.8K
Updated: CommitOct 17 Releasev24.2.0Oct 14
Age: 9y
Commits · 90 Days