# @aglyn/aglyn-markdown-editor 中文文档

规范地址：https://npmcn.com/package/%40aglyn/aglyn-markdown-editor/

版本：1\.19\.0
npm 元数据更新时间：2026-11-07T13:56:36.986Z
中文译文更新时间：2026-11-05T22:52:30.742Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40aglyn/aglyn-markdown-editor
原文对照：https://npmcn.com/package/%40aglyn/aglyn-markdown-editor/?lang=original
项目主页：https://aglyn.com/
源码仓库：https://github.com/aglyn/aglyn

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：414 kB，30 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：react ^19\.2\.8，@mui/material ^9\.3\.1，@mui/icons-material ^9\.3\.1
- 首次发布：2026-09-20T23:52:48.352Z
- 最新版本发布：2026-11-07T13:56:36.313Z
- 近 30 天下载量：10589（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：162（近 12 个月 162 个）

## 中文简介

Mark-lite WYSIWYG 编辑器:可视化表面,工具栏,源/可视化切换,HTML-to-mark-down 粘贴,链接对话框,以及只读视图. 这是Aglyn控制台的编辑 内容,一个 `@aglyn/besigner-ui` 用于 Markdown 立方体

## 安装

```sh
npm install @aglyn/aglyn-markdown-editor
```

也可以使用：`pnpm add @aglyn/aglyn-markdown-editor`、`yarn add @aglyn/aglyn-markdown-editor`、`bun add @aglyn/aglyn-markdown-editor`

## README

# @aglyn/aglyn-markdown-编辑器

标记-升 WYSIWYG 编辑器:视觉表面、工具栏、源/相 切换, HTML- to- markdown 粘贴, 链接对话框, 以及只读视图 。 这是 编辑 Aglyn 控制台对内容的用法,以及其中的用法 `@aglyn/besigner-ui` 用于Markdown组件 `content` 属性。 自己安装,如果 您需要编辑或预览 Aglyn 在 React 和 MUI 中的标记下-升方言 应用程序; 大部分消费者作为依赖 `@aglyn/besigner-ui`。 。 。 .

> 从Aglyn monorepo出版到npm. 随后的版本 [语义版本](https://semver.org/)。 。 。 .

## 安装

```
npm install @aglyn/aglyn-markdown-editor
```

同伴依赖性 :

-   `react`
-   `@mui/material`
-   `@mui/icons-material`

## 里面有什么东西

组件 :

-   `MarkdownField` 是完整字段:标签、工具栏、视觉 编辑器和原始源模式,由 `value` 财务报告和审定财务报表 `onChange`它需要一个 选项 `onPickImageFromMedia` 调用后, 调用者可以自行提供 媒体拾取器和 `editorRef` 手拿回来 `MarkdownFieldHandle` 页:1 插入所选图像.
-   `MarkdownVisualEditor` 是视觉编辑表面本身,以及 `MarkdownEditorToolbar` 是它的工具栏,对于拨出棋子的呼叫者 他们自己.
-   `MarkdownLinkDialog` 财务报告和审定财务报表 `LinkTargetAutocomplete` 是链接控件。 这个 自动完成提供呼叫者通过的目标,并搜索条目 当核心的链接-目标搜索上下文被挂载时.
-   `MarkdownLiteView` 使马克- 升 `source` 只读.

函数 :

-   `markdownToRows`, (中文(简体) ), `rowsToMarkdown` 财务报告和审定财务报表 `readInlinesFromElement` 转换 介于markdown-lite source和编辑器的行模型之间.
-   `htmlToRows` 财务报告和审定财务报表 `htmlToInlines` 转换已粘贴的 HTML.
-   `applyCommandToSource` 财务报告和审定财务报表 `applyLinkToSource` 将工具栏命令应用到一个 原始源选择.

标记下-升方言本身(它的分解器和序列器)生活在 `@aglyn/aglyn`不在这里。 这个包是UI在它上面.

每个文件下 `src/lib` 也可以通过子路径达到,例如 `@aglyn/aglyn-markdown-editor/markdown-lite-view.component`。 。 。 .

## 使用量

```tsx
import { MarkdownField, MarkdownLiteView } from '@aglyn/aglyn-markdown-editor'
import { useState } from 'react'

export function BodyEditor() {
  const [body, setBody] = useState('')
  return (
    <>
      <MarkdownField label="Body" value={body} onChange={setBody} />
      <MarkdownLiteView source={body} />
    </>
  )
}
```

## 怎样才合适

这个包裹坐落在 `core` 包图作为其UI 块的范围: 它 仅限进口 `@aglyn/aglyn`因为编辑会说"减"字 核心定义的方言. 这也是为什么它不是普通的 `@aglyn/shared-*` 软件包,可能不知道Aglyn的型号。 是个图书馆 而不是应用程序的一部分 因为控制台和设计者UI都需要 同名编辑。 它不导入插件, 也不导入其他 UI 软件包 .

## 许可证

阿帕奇2.0 (英语). 资料来源: [https://github.com/aglyn/aglyn/tree/main/libs/aglyn-markdown-editor 页面存档备份,存于互联网档案馆](https://github.com/aglyn/aglyn/tree/main/libs/aglyn-markdown-editor)

## 常见问题

### @aglyn/aglyn-markdown-editor 是什么？

Mark-lite WYSIWYG 编辑器:可视化表面,工具栏,源/可视化切换,HTML-to-mark-down 粘贴,链接对话框,以及只读视图\. 这是Aglyn控制台的编辑 内容,一个 @aglyn/besigner-ui 用于 Markdown 立方体

### 如何安装 @aglyn/aglyn-markdown-editor？

在项目目录运行 npm install @aglyn/aglyn-markdown-editor，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^19\.2\.8）、@mui/material（^9\.3\.1）、@mui/icons-material（^9\.3\.1）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @aglyn/aglyn-markdown-editor 支持 TypeScript 吗？

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

### @aglyn/aglyn-markdown-editor 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @aglyn/aglyn-markdown-editor 可以商用吗？

@aglyn/aglyn-markdown-editor 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @aglyn/aglyn-markdown-editor 的下载量有多少？

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

### @aglyn/aglyn-markdown-editor 还在维护吗？

最新版本 1\.19\.0 发布于 2026/11/07（今天）；至今共发布 162 个版本，其中过去 12 个月发布了 162 个；首次发布于 2026/09/21。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。