项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-11-21 · 当前星标 ★ 1032
使用教程
环境要求
- Node.js 运行环境(Node 下使用 Rust NAPI 引擎,边缘运行时使用 WASM)
- pnpm 包管理器
- 项目需支持 ES 模块,能使用 import 语法
安装与启动步骤
-
1安装 mdream 依赖
在项目根目录执行安装,README 使用 pnpm,安装后即可 import 使用。
pnpm add mdream -
2运行基础转换验证
调用 htmlToMarkdown 把 HTML 字符串转成 Markdown,输出以 # 开头的标题文本。
node --input-type=module -e "import { htmlToMarkdown } from 'mdream'; console.log(htmlToMarkdown('<h1>Hello World</h1>'))" -
3切换输出格式
通过 format 选项输出纯文本 text 或清洗后的 html,默认输出 Markdown。
node --input-type=module -e "import { htmlToMarkdown } from 'mdream'; console.log(htmlToMarkdown('<h1>Hello <strong>World</strong></h1>', { format: 'text' }))" -
4流式转换示例
边接收 HTML 边输出 Markdown,适合大页面;origin 与 minimal 为示例选项。
cat > stream.mjs <<'EOF' import { streamHtmlToMarkdown } from 'mdream' const response = await fetch('https://en.wikipedia.org/wiki/Markdown') for await (const chunk of streamHtmlToMarkdown(response.body, { origin: 'https://en.wikipedia.org', minimal: true, })) { process.stdout.write(chunk) } EOF node stream.mjs -
5浏览器免构建使用
引入 CDN 上的 iife 脚本,脚本自带 WASM 并自动初始化,调用返回 Promise。
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
format | 否 | 指定输出格式:markdown、text 或 html,默认 Markdown | text |
origin | 否 | 流式转换时提供页面来源地址,用于解析相对链接 | https://en.wikipedia.org |
minimal | 否 | 精简输出,减少冗余标记,适合送入大模型 | true |
如何确认成功
执行后控制台打印出「# Hello World」,说明转换库安装并运行正常。
常见问题
Q:没有 pnpm 怎么办?
A:README 中安装命令基于 pnpm,可先用 npm i -g pnpm 安装 pnpm,或在项目中使用同等包管理方式安装同名包。
Q:浏览器中为什么结果是 Promise?
A:从 mdream/browser 导入的 htmlToMarkdown 需 await 才能拿到字符串;CDN 的 iife 版本同理,返回 Promise。
Q:流式输出和一次性转换结果一致吗?
A:README 说明把流式输出的片段拼接后,结果与一次性转换一致。
Q:能直接输出纯文本吗?
A:可以,传入 format: 'text' 即可去掉 Markdown 标记,只保留文字内容。
注意事项
- Node.js 环境使用 Rust NAPI 引擎,边缘运行时使用 WASM,两者调用方式一致。
- README 仅提到存在 Docker 镜像但未给出具体命令,本教程不涉及镜像运行步骤。
- 升级到 v2 需按 README 的迁移章节调整调用方式。
- 转换前建议先用 format 与 minimal 选项控制输出体积,减少送入大模型的 token 消耗。
核心亮点
- 支持流式转换,可边接收 HTML 边输出 Markdown,适合大页面和抓取管线
- 针对 LLM 场景优化输出,减少导航、脚本等噪声,节省 token
- TypeScript 实现,API 简洁,易嵌入 Node 服务和 RAG 预处理流程
不足之处
- 项目较新、星标约千级,生态与长期维护稳定性待观察
- 复杂页面(如重脚本渲染、异常嵌套标签)的转换保真度需实测验证
适用场景
- 爬虫抓取网页后批量转 Markdown 入库
- RAG 知识库构建前的网页正文清洗
- 把在线文档或文章转成 Markdown 供 LLM 摘要与问答
替代项目
turndown、html-to-markdown、readability
上一篇:island
下一篇:没有了!
同类项目推荐
slide-deck-ai
开源
输入主题,AI 自动生成整套 PPT 幻灯片
Co-create PowerPoint slide decks with AI
llama-scan
开源
本地大模型把扫描 PDF 转成可编辑文本
Transcribe PDFs with local LLMs
gridcraft
开源
纯 Rust 写的 Excel,安全又轻快
GridCraft: an open-source, clean-room spreadsheet in pure Rust. By ArtCraft.
slidev-ai
开源
输入主题,AI 自动生成 Slidev 幻灯片,省时省力
ai app for slidev
readmeX
开源
丢进代码库,自动生成中文 README 和可浏览 Wiki
An AI Powered README and Interactive Wiki Generator for Any Projects. AI驱动的README···
macshot
开源
原生截图录屏,自动打码+OCR翻译,免订阅
Feature-packed native macOS screenshot & recording tool: annotate, auto-redact PII, ···
GithubStarsManager
开源
用大白话搜星标,AI 自动分类并追更新
AI-powered GitHub stars manager with semantic search, auto-categorization, and relea···
jkinco-listen-open
开源
本地跑完录音转纪要,不联网不传数据
MeetDo — open-source Meeting-to-Action AI by 筑听 · JKinco Listen. Self-hosted liv···
awesome-spec-driven-development
开源
找全规范驱动开发资源,快速落地契约优先流程
A curated list of awesome resources for spec-driven development (SDD)
