# @diplodoc/transform 中文文档

规范地址：https://npmcn.com/package/%40diplodoc/transform/

版本：4\.78\.13
npm 元数据更新时间：2026-11-09T10:12:41.753Z
中文译文更新时间：2026-11-12T10:41:41.174Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：4.6 MB，492 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：23 个
- peer 依赖：highlight\.js ^10\.0\.3 \|\| ^11
- 首次发布：2023-09-22T15:18:41.153Z
- 最新版本发布：2026-11-09T10:12:41.313Z
- 近 30 天下载量：60132（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：250（近 12 个月 82 个）

## 中文简介

YFM( Yandex Flavored Markdown) 文本到 HTML 的简单变压器

## 安装

```sh
npm install @diplodoc/transform
```

也可以使用：`pnpm add @diplodoc/transform`、`yarn add @diplodoc/transform`、`bun add @diplodoc/transform`

## README

[英语](https://github.com/diplodoc-platform/transform/blob/master/README.md) | **русский**

* * *

[![NPM version](https://img.shields.io/npm/v/@diplodoc/transform.svg?style=flat)](https://www.npmjs.org/package/@diplodoc/transform) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=diplodoc-platform_transform&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=diplodoc-platform_transform) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=diplodoc-platform_transform&metric=coverage)](https://sonarcloud.io/summary/new_code?id=diplodoc-platform_transform) [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=diplodoc-platform_transform&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=diplodoc-platform_transform) [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=diplodoc-platform_transform&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=diplodoc-platform_transform) [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=diplodoc-platform_transform&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=diplodoc-platform_transform)

# Diplodoc 变换

Yandex Flavored Markdown = HTML (简体中文).

{\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}你觉得怎么样? Например,чтобы也.

## {\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}你觉得呢

1.  校对:Soup
    
    ```shell
    npm i @diplodoc/transform
    ```
    
2.  {\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}我.. `require()` или `import()`数字 :
    
    ```javascript
    const transform = require('@diplodoc/transform');
    ```
    
3.  CSS - \\ \\ \\ \\ \\ \\ \\ \\ \\
    
    ```css
    @import '~@diplodoc/transform/dist/css/yfm.css';
    ```
    
    ```javascript
    import '@diplodoc/transform/dist/js/yfm';
    ```
    

## {\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}你觉得呢

{\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}你觉得呢 `transform()`数字 :

-   {\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}嘿! {\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}嘿 [настройки](https://npmcn.com/package/%40diplodoc/transform/settings.md)· ;
-   {\\fn黑体\\fs22\\bord1\\shad0\\3ahbe\\4ah00\\fscx67\\fscy66\\2chffffff\\3ch808080}别这样 `result` и `logs`。 。 。 .

### 结果

`result` . . . .

-   `html` - \\ \\ \\ \\ \\ HTML .
-   `meta` —— 说 [метаданные](https://npmcn.com/package/syntax/meta.md#meta) из.
-   `title` ——заголовок. Возвращается,если也 `extractTitle = true` или `needTitle = true`。 。 。 .
-   `headings` - 。 。 。 。 .

### 逻辑

`logs` . . . . .

-   `error` - 额...
-   `warn` - 额...
-   `info` ——дополнительная.

### {\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}你觉得呢

```javascript
const fs = require('fs');
const transform = require('@diplodoc/transform');

const content = fs.readFileSync(filePath, 'utf');
const vars = {user: {name: 'Alice'}};

const {
  result: {html, meta, title, headings},
  logs,
} = transform(content, {vars});
```

### Пользовательский HTML - санитайзер

Вы заменить HTML-санитайзер собственной реализацией реализацией реализацией реализацией передав `sanitize` qq 时 :

```javascript
const customSanitizer = (html, options) => {
  // Ваша логика санитизации
  return sanitizedHtml;
};

const {result} = transform(content, {
  sanitize: customSanitizer,
  // Другие опции...
});
```

{\\fn黑体\\fs20\\shad2\\2aH82\\3aH20\\4aH33\\fscx95\\3cH592001\\be1}你觉得怎么样? # # # # # HTML - # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #.

## 许可证

麻省理工学院

## \===============================================================================================================================================================

**常见**

-   `--yfm-color-text`
-   `--yfm-color-link`
-   `--yfm-color-base`
-   `--yfm-color-link-hover`
-   `--yfm-color-table`
-   `--yfm-color-table-row-background`
-   `--yfm-color-border`
-   `--yfm-color-accent`
-   `--yfm-tab-size`
-   `--yfm-text-block-margin-block`
-   `--yfm-text-block-margin-inline`
-   `--yfm-font-size`
-   `--yfm-font-line-height`
-   `--yfm-font-size-h1`
-   `--yfm-font-line-height-h1`
-   `--yfm-font-size-h2`
-   `--yfm-font-line-height-h2`
-   `--yfm-font-size-h3`
-   `--yfm-font-line-height-h3`
-   `--yfm-font-size-h4`
-   `--yfm-font-line-height-h4`
-   `--yfm-font-size-h5`
-   `--yfm-font-line-height-h5`
-   `--yfm-font-size-h6`
-   `--yfm-font-line-height-h6`
-   `--yfm-hr-height`
-   `--yfm-hr-margin`

**代码**

-   `--yfm-color-inline-code`
-   `--yfm-color-inline-code-background`
-   `--yfm-color-code-background`
-   `--yfm-tab-size-code`

**高光灯**

-   `--yfm-color-hljs-background`
-   `--yfm-color-hljs-subst`
-   `--yfm-color-hljs-comment`
-   `--yfm-color-hljs-deletion`
-   `--yfm-color-hljs-section`
-   `--yfm-color-hljs-pseudo`
-   `--yfm-color-hljs-literal`
-   `--yfm-color-hljs-addition`
-   `--yfm-color-hljs-meta`
-   `--yfm-color-hljs-meta-string`

**说明**

-   `--yfm-color-note-tip`
-   `--yfm-color-note-tip-background`
-   `--yfm-color-note-warning`
-   `--yfm-color-note-warning-background`
-   `--yfm-color-note-important-background`
-   `--yfm-color-note-info`
-   `--yfm-color-note-info-background`

**任期**

-   `--yfm-color-term-title`
-   `--yfm-color-term-title-hover`
-   `--yfm-color-term-dfn-background`
-   `--yfm-color-term-dfn-shadow`
-   `--yfm-color-term-dfn-pseudo-shadow`

**模式**

-   `--yfm-color-modal-content`
-   `--yfm-color-modal-actions-hover`
-   `--yfm-color-modal-wide-content`
-   `--yfm-color-modal-wide-content-overlay`

**文件**

-   `--yfm-file-icon`
-   `--yfm-file-icon-color`

**列表**

-   `--yfm-list-item-margin-block`
-   `--yfm-list-text-margin-block`
-   `--yfm-list-text-only-margin-block`
-   `--yfm-list-text-last-margin-block`

## Контрибуции

### Тесты

\-=YTET -伊甸园字幕组=- 翻译: Playwright - \\\\\\ n {\\fn黑体\\fs22\\bord1\\shad0\\3ahbe\\4ah00\\fscx67\\fscy66\\2chffffff\\3ch808080}你觉得呢 `e2e`。 。 。 .

#### 剧作家:先决条件

唵(引一)обеспечить(二合引一)факторов(二合引一)факторов(二合引一)запускать(引一) 尔时金刚手菩萨. Playwright - \\ \\ \\ \\ \\ \\ \\ \\ `test:playwright`。 。 。 . {\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}你觉得呢.

```sh
$ npm run test:playwright
```

Docker CLI)的"多克引擎".

{\\fn黑体\\fs20\\shad2\\2aH82\\3aH20\\4aH33\\fscx95\\3cH592001\\be1}♪##########################UI-############### 剧作家#### `playwright:docker:ui` (单位: @%e2e):

```sh
$ cd e2e
$ npm run playwright:docker:ui
```

##### {\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}什么? {\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}什么?

{\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}嘿! {\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}嘿! {\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}嘿 {\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}你觉得呢? Используйте [利马](https://github.com/lima-vm/lima) или,таких也 [科利马](https://github.com/abiosoft/colima) или [Rancher 桌面](https://rancherdesktop.io/)。 。 。 .

{\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}你觉得呢 `docker`, можете с с `LIMA_INSTANCE` {\\fn黑体\\fs22\\bord1\\shad0\\3ahbe\\4ah00\\fscx67\\fscy66\\2chffffff\\3ch808080}你该知道 {\\fn黑体\\fs22\\bord1\\shad0\\3ahbe\\4ah00\\fscx67\\fscy66\\2chffffff\\3ch808080} `playwright:docker`编号 :`test:playwright`数字 :

```sh
$ LIMA_INSTANCE=instancename npm run test:playwright
```

{\\fn黑体\\fs20\\shad2\\2aH82\\3aH20\\4aH33\\fscx95\\3cH592001\\be1}你觉得呢 `DOCKER_HOST`。 。 。 .

## 常见问题

### @diplodoc/transform 是什么？

YFM\( Yandex Flavored Markdown\) 文本到 HTML 的简单变压器

### 如何安装 @diplodoc/transform？

在项目目录运行 npm install @diplodoc/transform，或使用 pnpm add / yarn add / bun add。

### @diplodoc/transform 支持 TypeScript 吗？

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

### @diplodoc/transform 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @diplodoc/transform 可以商用吗？

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

### @diplodoc/transform 的下载量有多少？

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

### @diplodoc/transform 还在维护吗？

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