块编辑器开发文档

@wordpress/annotations

💡 云策文档标注

概述

@wordpress/annotations 是一个用于在 Gutenberg 编辑器中为内容添加注释的 npm 包。它需要 ES2015+ 环境支持,并依赖于 wp-annotations 脚本。

关键要点

  • 安装方式:通过 npm install @wordpress/annotations --save 安装包。
  • 环境要求:需要 ES2015+ 环境,否则需包含 @wordpress/babel-preset-default 中的 polyfill。
  • 依赖管理:在使用 Annotations API 的 JavaScript 文件中,需将 wp-annotations 作为依赖项引入。
  • 项目结构:此包是 Gutenberg 项目 monorepo 的一部分,用于 WordPress 和其他软件项目。

注意事项

详细使用说明请参考官方文档页面;贡献指南请阅读 Gutenberg 项目的主要贡献者指南。


📄 原文内容

Annotate content in the Gutenberg editor.

Installation

Install the module

npm install @wordpress/annotations --save

This package assumes that your code will run in an ES2015+ environment. If you’re using an environment that has limited or no support for such language features and APIs, you should include the polyfill shipped in @wordpress/babel-preset-default in your code.

Getting Started

You need to include wp-annotations as a dependency of the JavaScript file in which you wish to use the Annotations API.

Usage

See this page for more detailed usage instructions.

Contributing to this package

This is an individual package that’s part of the Gutenberg project. The project is organized as a monorepo. It’s made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to npm and used by WordPress as well as other software projects.

To find out more about contributing to this package or Gutenberg as a whole, please read the project’s main contributor guide.