# @bpmn-io/snarkdown 中文文档
规范地址：https://npmcn.com/package/%40bpmn-io/snarkdown/
版本：2\.2\.0
npm 元数据更新时间：2026-07-08T15:59:16.162Z
中文译文更新时间：2026-11-08T14:33:18.962Z
软件包许可：MIT
本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。
原始 npm 页面：https://www.npmjs.com/package/%40bpmn-io/snarkdown
原文对照：https://npmcn.com/package/%40bpmn-io/snarkdown/?lang=original
项目主页：https://github.com/bpmn-io/snarkdown
源码仓库：https://github.com/bpmn-io/snarkdown
弃用说明：Package no longer supported\. Contact Support at https://www\.npmjs\.com/support for more info\.
## 关键信息（来自 npm 元数据）
- 包体积（解压后）：42.8 kB，13 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2021-06-30T07:53:14.358Z
- 最新版本发布：2023-02-07T14:24:28.243Z
- 近 30 天下载量：1944（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 0 个）
## 中文简介
将 Markdown 转换为 HTML .
## 安装
```sh
npm install @bpmn-io/snarkdown
```
也可以使用：`pnpm add @bpmn-io/snarkdown`、`yarn add @bpmn-io/snarkdown`、`bun add @bpmn-io/snarkdown`
## README
> 一个叉子 [弯腰](https://github.com/developit/snarkdown) 与 [应用的一些修正](https://github.com/developit/snarkdown/compare/main...bpmn-io:main)。 。 。 .
# 击倒 [ ](https://www.npmjs.org/package/@bpmn-io/snarkdown)[](https://github.com/bpmn-io/snarkdown/actions?query=workflow%3ACI)
Snarkdown是一个死简单的 **1kb (韩语)** [标记](http://daringfireball.net/projects/markdown/) par.
它被设计为尽可能的最小, 对于受限制的使用案例, 完全Markdown 解析器是不合适的.
## 特征
- **快速 :** 因为它基本上是一个regex和一个巨大的如果声明
- **小声:** 这是一克平分的ES3
- **简单 :** 通过 Markdown 字符串, 获取 HTML 字符串
> **说明:** 表格尚未支持。 如果你喜欢无法读取正则表达式,请提交公关!
>
> **关于SS的说明:** 击倒 [不消毒 HTML](https://github.com/developit/snarkdown/issues/70)因为它的主要用途并不需要它.
## 演示文稿实例( E)
- ⚛️ [**斯纳克**](https://snarky.surge.sh/) - 使用 Preact & Snarkdown 创建的马克下调编辑器
- ✏️ [**简单的下沉编辑器**](http://jsfiddle.net/developit/828w6t1x/)
## 使用量
Snarkdown 输出一个函数,该函数剖析出一串 Markdown 并返回一串 HTML 。 再简单不过了.
Snakdown 模块在 [每个模块格式](https://unpkg.com/@bpmn-io/snarkdown/dist/) eS模块,通用JS,UMD...
```js
import snarkdown from '@bpmn-io/snarkdown';
let md = '_this_ is **easy** to `use`.';
let html = snarkdown(md);
console.log(html);
// this is easy to use.
```
### 添加和图书馆
- 对于Webpack用户, [`snarkdown-loader`](https://github.com/Plugin-contrib/snarkdown-loader) 将 markdown 文件变成 html .
## 常见问题
### @bpmn-io/snarkdown 是什么？
将 Markdown 转换为 HTML \.注意：该包已被作者标记为弃用——Package no longer supported\. Contact Support at https://www\.npmjs\.com/support for more info\.
### 如何安装 @bpmn-io/snarkdown？
在项目目录运行 npm install @bpmn-io/snarkdown，或使用 pnpm add / yarn add / bun add。
### @bpmn-io/snarkdown 支持 TypeScript 吗？
支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。
### @bpmn-io/snarkdown 支持 ESM 还是 CommonJS？
同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。
### @bpmn-io/snarkdown 可以商用吗？
@bpmn-io/snarkdown 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。
### @bpmn-io/snarkdown 的下载量有多少？
根据 npm 官方下载统计，@bpmn-io/snarkdown 在 2026/10/09 – 2026/11/07 这 30 天内被下载 1,944 次，日均约 65 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。
### @bpmn-io/snarkdown 还在维护吗？
最新版本 2\.2\.0 发布于 2023/02/07（3 年前）；至今共发布 3 个版本，其中过去 12 个月发布了 0 个；首次发布于 2021/06/30。作者已将其标记为弃用，新项目建议寻找替代方案。