@codeflex/tiptap-markdown

中文文档
0.8.11发布于 2024/09/28MITTypeScriptESM + CJS近 30 天下载 6029

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

中文使用文档
文档目录9 节
  1. 安装
  2. 所需资源
  3. 使用量
  4. API 密码
  5. 选项
  6. 方法
  7. 自定义扩展名
  8. 捐款
  9. 许可证

缩放标记

下标扩展 Tiptap 编辑器。 。 。 .

3⁄4 ̄ ̧漯B
从v. 7.0起, createMarkdownEditor 已经放弃了一个更友好的 Markdown Tittap 扩展名 。 见 移徙指南。 。 。 .

安装

npm install tiptap-markdown

所需资源

支持由 Tiptap 处理的所有框架( 第 2 个 Vue 3 个 Vue 3, React, 参见完整列表. ) (中文(简体) )

使用量

基本实例:

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 密码

选项

默认选项 :

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
})

方法

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

自定义扩展名

见 实例。 。 。 .
检查亲子标记 默认序列器 用于序列化配置的示例。 检查出标记下 插件 为解析.

捐款

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

请确保酌情更新测试.

许可证

麻省理工学院许可证(MIT). 请看 许可证文件 更多信息.

版本与发布记录

@codeflex/tiptap-markdown 共发布 2 个版本,首次发布于 2024/09/06;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.8.11latest2024/09/282 年前
0.8.102024/09/062 年前

关于 @codeflex/tiptap-markdown 的常见问题

@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 和提交记录判断。