@gravity-ui/markdown-editor

中文文档
15.50.0发布于 2026/11/11MITTypeScriptESM + CJS构建来源已验证近 30 天下载 4.5万

Markdown wysiwyg 和 markup 编辑器

中文使用文档
文档目录14 节
  1. Markdown wysiwyg 和 markup 编辑器
  2. 主要特点
  3. 安装
  4. 所需依赖关系
  5. 开始
  6. 发展
  7. i18n (英语)
  8. 捐款
  9. 许可证
  10. 对于人工智能特工
  11. 何时使用
  12. 不使用时
  13. 常见陷阱
  14. AI代理的文件

Markdown Editor

@gravity-ui/markdown-editor ! (简体中文) npm package CI Release storybook

Markdown wysiwyg 和 markup 编辑器

MarkdownEditor是和Markdown合作的强大工具,它结合了WYSIWYG和Markup模式. 这意味着您可以在方便的视觉模式下创建和编辑内容,同时也能完全控制标记.

主要特点

  • 支持基本的Markdown和 YFM 调频 语法.
  • 通过使用ProseMiror和CodeMiror引擎的可扩展性.
  • 在WYSIWYG和Markup模式中工作的能力以达到最大灵活性.

安装

npm install @gravity-ui/markdown-editor

所需依赖关系

请注意,要开始使用软件包,您的项目还必须安装以下设备: @diplodoc/transform, (中文(简体) ), react, (中文(简体) ), react-dom, (中文(简体) ), @gravity-ui/uikit, (中文(简体) ), @gravity-ui/components 还有一些 看看这个 peerDependencies 节 package.json 为了准确的信息.

开始

Markdown编辑器作为反应钩子提供,以创建编辑器实例和渲染视图的组件.
设置外观和主题 UIKit 文档。 。 。 .

import React from 'react';
import {useMarkdownEditor, MarkdownEditorView} from '@gravity-ui/markdown-editor';

function Editor({onSubmit}) {
  const editor = useMarkdownEditor({allowHTML: false});

  React.useEffect(() => {
    function submitHandler() {
      // Serialize current content to markdown markup
      const value = editor.getValue();
      onSubmit(value);
    }

    editor.on('submit', submitHandler);
    return () => {
      editor.off('submit', submitHandler);
    };
  }, [onSubmit]);

  return <MarkdownEditorView stickyToolbar autofocus editor={editor} />;
}

更多信息:

发展

  1. 安装节点环境, 版本在 .nvmrc 文档。 我们建议使用 国家核查团 或类似的工具.
  2. 安装 小时,该版本在 package.json 在"包装经理"属性.
  3. 安装依赖性 : pnpm i
  4. 运行故事本 dev- server : pnpm start

i18n (英语)

要建立国际化,你只需要使用 configure数字 :

import {configure} from '@gravity-ui/markdown-editor';

configure({
  lang: 'ru',
});

别忘了打电话 configure() 从 用户界面Kit 和其他UI图书馆.

捐款

许可证

根据麻省理工学院的许可证分发。 见 自由主义 详细情况.

对于人工智能特工

用于React的双模版Markdown编辑器,结合了WYSIWYG模式(ProseMiror)和生标记模式(CodeMiror),支持基本的Markdown和YFM.

何时使用

  • 用可切换的视觉(WYSIWYG)和源(markup)视图来编辑Markdown/YFM内容.
  • 您需要一个可扩展编辑器: 自定义标记、节点、工具栏项目,以及通过ProseMiror/CodeMiror引擎的扩展(HTML、LaTeX、Mermaid、GPT).
  • 渲染编辑器 UI: 用 useMarkdownEditor 并把它变成 MarkdownEditorView。 。 。 .

不使用时

  • 只读 Markdown 渲染到 HTML 而不编辑 – 用 @diplodoc/transform 并生成输出.
  • 普通多行文本输入——使用 TextArea 从 @gravity-ui/uikit。 。 。 .
  • 富文不是Markdown/YFM——这个编辑器是Markdown-first.

常见陷阱

  • 这是一个钩子加一个视图,而不是一个组成部分. 创建实例 useMarkdownEditor(...) 并传递给 <MarkdownEditorView editor={editor} />; 没有单一 <MarkdownEditor> 你直接变身.
  • 通过实例读取值, 而不是控制值 value 道具 (英语). 打电话 editor.getValue() (例如: submit 事件)将序列化到Markdown;编辑器管理自己的状态.
  • 需要依赖同伴. 您的项目必须提供 @diplodoc/transform, (中文(简体) ), @gravity-ui/uikit, (中文(简体) ), @gravity-ui/components, (中文(简体) ), react,以及 react-dom - 检查一下 peerDependencies 内 package.json。 。 。 .
  • 样式和i18n来自uikit. 按 uikit 文件设置主题/ 样式并调用 configure({lang}) 从本套件和 @gravity-ui/uikit。 。 。 .

AI代理的文件

安装版本的可代理读取文档位于 node_modules/@gravity-ui/markdown-editor/build/docs/INDEX.md。 。 。 .

版本与发布记录

@gravity-ui/markdown-editor 共发布 163 个版本,首次发布于 2024/06/07;过去 12 个月发布了 39 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
15.50.0latest2026/11/115 天前
15.49.02026/10/2721 天前
15.48.12026/10/021 个月前
15.48.22026/10/021 个月前
15.48.02026/09/301 个月前
15.47.12026/09/291 个月前

其他发布通道:untagged → 14.13.0。

关于 @gravity-ui/markdown-editor 的常见问题

@gravity-ui/markdown-editor 是什么?

Markdown wysiwyg 和 markup 编辑器

如何安装 @gravity-ui/markdown-editor?

在项目目录运行 npm install @gravity-ui/markdown-editor,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:katex(^0.16.9)、react(^16.14.0 || ^17.0.0 || ^18.0.0 || ^19.0.0)、react-dom(^16.14.0 || ^17.0.0 || ^18.0.0 || ^19.0.0)、markdown-it(^13.0.0)、@gravity-ui/uikit(^7.1.0)、@diplodoc/transform(^4.43.0)、@gravity-ui/components(^4.10.0)、@diplodoc/cut-extension(^0.5.0 || ^0.6.1 || ^0.7.1 || ^1.0.0)、@diplodoc/file-extension(^0.2.1)、@diplodoc/tabs-extension(^3.5.1)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@gravity-ui/markdown-editor 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@gravity-ui/markdown-editor 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@gravity-ui/markdown-editor 可以商用吗?

@gravity-ui/markdown-editor 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@gravity-ui/markdown-editor 的下载量有多少?

根据 npm 官方下载统计,@gravity-ui/markdown-editor 在 2026/10/17 – 2026/11/15 这 30 天内被下载 44,757 次,日均约 1,492 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@gravity-ui/markdown-editor 还在维护吗?

最新版本 15.50.0 发布于 2026/11/11(5 天前);至今共发布 163 个版本,其中过去 12 个月发布了 39 个;首次发布于 2024/06/07。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。