Repolode
codex-team

codex-team/editor.js

一款块级结构的 Web 富文本编辑器,内容以简洁的 JSON 格式保存,功能通过插件扩展。

可替代:Notion

Star
31,970
Fork
2,244
未关闭 Issue
711
最近提交
4小时前

这是什么?

Editor.js 是一款开源的 Web 块级编辑器。内容由文本、标题、图片、列表、引用、代码等块组成,每种块类型都由独立的工具插件提供。

编辑器不输出 HTML 标记,而是生成结构化的 JSON 数据。这些数据易于清洗、存储,并可在 Web、iOS、Android 等多种平台上渲染,适合需要稳定数据格式的内容处理流程。调用 editor.save() 即可异步获取当前内容。

项目以 @editorjs/editorjs 包的形式发布在 npm 上,使用 TypeScript 编写。官方工具覆盖标题、引用、图片、待办清单、表格、嵌入内容等,第三方工具可在社区列表中找到。

核心功能

  • 01输出简洁的 JSON 数据,而非 HTML 标记
  • 02块级界面,可自由添加和调整内容顺序
  • 03每种块类型由独立的插件工具提供
  • 04官方工具涵盖标题、图片、表格、待办清单和嵌入内容
  • 05通过 editor.save() 获取内容的简单 API

适用场景

  • 构建富文本内容编辑器,输出数据需在多个平台渲染
  • 为 Web 应用添加结构化的文章或博客编辑器
  • 通过自定义块工具开发定制化编辑器

快速上手

  1. 1

    使用 npm 安装 Editor.js

    npm i @editorjs/editorjs
  2. 2

    安装 README 中列出的所需工具

  3. 3

    在页面中添加 id 为 editorjs 的容器 div

  4. 4

    导入 EditorJS 并使用所需工具创建实例

使用前须知

  • 每种块类型都需要单独的工具插件,因此必须安装并配置所需工具。
  • 保存内容需要调用 editor.save() 并处理返回的 Promise。

标签

常见问题

editor.js 是什么?
一款块级结构的 Web 富文本编辑器,内容以简洁的 JSON 格式保存,功能通过插件扩展。 Editor.js 是一款开源的 Web 块级编辑器。内容由文本、标题、图片、列表、引用、代码等块组成,每种块类型都由独立的工具插件提供。
editor.js 可以免费使用吗?用的什么许可证?
editor.js 以 Apache-2.0 许可证开源。用于商业产品前,请先确认许可证条款。
editor.js 还在维护吗?
活跃维护中。editor.js 最近一次提交是在 2026年10月21日。
editor.js 适合用来做什么?
构建富文本内容编辑器,输出数据需在多个平台渲染 为 Web 应用添加结构化的文章或博客编辑器 通过自定义块工具开发定制化编辑器
editor.js 怎么安装和运行?
使用 npm 安装 Editor.js: npm i @editorjs/editorjs 安装 README 中列出的所需工具 在页面中添加 id 为 editorjs 的容器 div 导入 EditorJS 并使用所需工具创建实例
在哪里获取 editor.js?
源代码和安装说明在 GitHub 上:https://github.com/codex-team/editor.js

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目