# @codeflex/tiptap-markdown 中文文档

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

版本：0\.8\.11
npm 元数据更新时间：2024-09-28T05:15:14.021Z
中文译文更新时间：2026-11-10T06:37:26.381Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：239 kB，41 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：4 个
- peer 依赖：@tiptap/core ^2\.6\.6
- 首次发布：2024-09-06T09:59:56.341Z
- 最新版本发布：2024-09-28T05:15:13.823Z
- 近 30 天下载量：6029（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：2（近 12 个月 0 个）

## 中文简介

在 Tittap 编辑器中编辑标记下的内容 .

## 安装

```sh
npm install @codeflex/tiptap-markdown
```

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

## README

# 缩放标记

下标扩展 [Tiptap 编辑器](https://www.tiptap.dev/)。 。 。 .

> **3⁄4 ̄ ̧漯B**  
> 从v. 7.0起, `createMarkdownEditor` 已经放弃了一个更友好的 `Markdown` Tittap 扩展名 。 见 [移徙指南](https://github.com/aguingand/tiptap-markdown/blob/main/docs/migration.md)。 。 。 .

## 安装

```bash
npm install tiptap-markdown
```

### 所需资源

支持由 Tiptap 处理的所有框架( 第 2 个 Vue 3 个 Vue 3, React, [参见完整列表](https://www.tiptap.dev/installation#integration-guides). ) (中文(简体) )

## 使用量

基本实例:

```js
import { Editor } from '@tiptap/core';
import StarterKit from '@tiptap/starter-kit';
import { Markdown } from 'tiptap-markdown';

const editor = new Editor({
    content: "# Title",
    extensions: [
        StarterKit,
        Markdown,
    ],
});
const markdownOutput = editor.storage.markdown.getMarkdown();
```

## API 密码

### 选项

默认选项 :

```js
Markdown.configure({
  html: true,                  // Allow HTML input/output
  tightLists: true,            // No <p> inside <li> in markdown output
  tightListClass: 'tight',     // Add class to <ul> allowing you to remove <p> margins when tight
  bulletListMarker: '-',       // <li> prefix in markdown output
  linkify: false,              // Create links from "https://..." text
  breaks: false,               // New lines (\n) in markdown input are converted to <br>
  transformPastedText: false,  // Allow to paste markdown text in the editor
  transformCopiedText: false,  // Copied text is transformed to markdown
})
```

### 方法

```js
editor.commands.setContent('**test**') // setContent supports markdown format
editor.storage.markdown.getMarkdown(); // get current content as markdown
```

### 自定义扩展名

见 [实例](https://github.com/aguingand/tiptap-markdown/tree/main/example/src/extensions)。 。 。 .  
检查亲子标记 [默认序列器](https://github.com/ProseMirror/prosemirror-markdown/blob/master/src/to_markdown.ts#L66) 用于序列化配置的示例。 检查出标记下 [插件](https://github.com/markdown-it/markdown-it#syntax-extensions) 为解析.

## 捐款

欢迎拉动请求。 对于重大变动,请先开出一个问题来讨论你想要改变什么.

请确保酌情更新测试.

## 许可证

麻省理工学院许可证(MIT). 请看 [许可证文件](https://npmcn.com/package/%40codeflex/tiptap-markdown/LICENSE) 更多信息.

## 常见问题

### @codeflex/tiptap-markdown 是什么？

在 Tittap 编辑器中编辑标记下的内容 \.

### 如何安装 @codeflex/tiptap-markdown？

在项目目录运行 npm install @codeflex/tiptap-markdown，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@tiptap/core（^2\.6\.6）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @codeflex/tiptap-markdown 支持 TypeScript 吗？

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

### @codeflex/tiptap-markdown 支持 ESM 还是 CommonJS？

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

### @codeflex/tiptap-markdown 可以商用吗？

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

### @codeflex/tiptap-markdown 的下载量有多少？

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

### @codeflex/tiptap-markdown 还在维护吗？

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