# 02strich-markdown 中文文档

规范地址：https://npmcn.com/package/02strich-markdown/

版本：1\.0\.2
npm 元数据更新时间：2023-04-05T15:49:26.226Z
中文译文更新时间：2026-10-31T11:01:33.730Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/02strich-markdown
原文对照：https://npmcn.com/package/02strich-markdown/?lang=original
项目主页：https://rdmd.readme.io/
源码仓库：https://github.com/02strich/markdown

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

- 包体积（解压后）：3 MB，32 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：27 个
- peer 依赖：@readme/variable ^15\.1\.0，@tippyjs/react ^4\.1\.0，react ^17\.0\.0，react-dom ^17\.0\.0
- 首次发布：2023-03-21T18:51:47.125Z
- 最新版本发布：2023-04-05T15:49:26.076Z
- 已发布版本数：3（近 12 个月 0 个）

## 中文简介

ReadMe的基于react的Markdown解析器

## 安装

```sh
npm install 02strich-markdown
```

也可以使用：`pnpm add 02strich-markdown`、`yarn add 02strich-markdown`、`bun add 02strich-markdown`

## README

# @readme /减价

![](https://owlbertsio-resized.s3.amazonaws.com/Reading.psd.full.png)

ReadMe的风味Markdown解析器和MDX渲染引擎。 ![RDMD CI Status](https://github.com/readmeio/markdown/workflows/CI/badge.svg)

```
npm install --save @readme/markdown
```

## 使用

默认情况下，更新后的markdown包导出一个函数，该函数接受字符串 [ReadMe-flavored减价](https://docs.readme.com/rdmd/docs/syntax-extensions) 并返回一个React组件树：

```jsx
import React from 'react';
import rdmd from "@readme/markdown";

export default ({ body }) => (
  <div className="markdown-body">
    {rdmd(body)}
  </div>
);
```

### 出口的方法

除了默认的React处理器，该包还导出了一些其他的方法来转换readme风格的markdown：

| 出口 | 描述 | 参数 |
| --: | :-- | :-- |
| _`react`_ | _(默认)_ 返回一个VDOM树对象 | `text`， `options` |
| _`md`_ | 将mast转换为readme风格的markdown | `tree`， `options` |
| _`html`_ | 将标记转换为HTML | `text`， `options` |
| _`mdast`_ | 将标记转换为目标对象 | `text`， `options` |
| _`hast`_ | 将标记转换为HAST对象 | `text`， `options` |
| _`plain`_ | 将标记转换为纯文本 | `text`， `options` |
| _`utils`_ | 上下文、默认值、帮助程序等。 | N/A |

### 设置和选项

每个处理器方法都有一个options对象，你可以用它来调整输出的HTML或React树。这些选项包括：

-   **`compatibilityMode`** ——允许 [兼容性特性](https://github.com/readmeio/api-explorer/issues/668) 从我们旧的降价引擎。
-   **`copyButtons`** -自动插入一个按钮复制文本块到剪贴板。目前使用于 `<code>` 元素。
-   **`correctnewlines`** -将新的行分隔符呈现为 `<br>` 标签。
-   **`markdownOptions`** ——备注 [解析器选项](https://github.com/remarkjs/remark/tree/main/packages/remark-stringify#processorusestringify-options).
-   **`safeMode`** -渲染html块为 `<pre>` 元素。我们通常允许所有可能执行JavaScript的html属性。

## 味的语法

我们的旧编辑器从自定义的、基于json的语法呈现“Magic Block”组件。为了提供无缝的向后兼容性，我们的新处理器内置了对解析这种旧格式的支持，并将其直接转换为我们新的、经过调味的Markdown。

我们还在上面撒了一点我们自己的语法糖，让您可以对文档进行增压。 [**了解有关ReadMe风味语法的更多信息！**](https://docs.readme.com/rdmd/docs/syntax-extensions)

## 地方发展

要在本地更改rmd引擎，请运行本地开发服务器。克隆回购， `cd` 在它里面， `npm install`, `npm run start`！

### 环境设置

运行浏览器测试需要 `docker`． 跟着码头走 [MAC安装说明](https://docs.docker.com/docker-for-mac/install/)。你可能想要增加 [内存使用情况](https://docs.docker.com/docker-for-mac/#resources)． 如果你还没有，你需要创建一个帐户 `docker hub` 和 [本地登录](https://docs.docker.com/docker-for-mac/#docker-hub).

### 运行视觉回归测试

如果更改了文档或更改了markdown的呈现方式，则可能需要更新可视化回归快照。你可以在docker容器中运行可视化回归测试：

```
make updateSnapshot
```

## 学分

-   **许可证**:麻省理工学院
-   **作者**： [Dom哈林顿](https://github.com/domharrington/)， [雷夫戈德堡](https://github.com/rafegoldberg)

## 常见问题

### 02strich-markdown 是什么？

ReadMe的基于react的Markdown解析器

### 如何安装 02strich-markdown？

在项目目录运行 npm install 02strich-markdown，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@readme/variable（^15\.1\.0）、@tippyjs/react（^4\.1\.0）、react（^17\.0\.0）、react-dom（^17\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### 02strich-markdown 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/02strich-markdown 是否存在。

### 02strich-markdown 支持 ESM 还是 CommonJS？

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

### 02strich-markdown 可以商用吗？

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

### 02strich-markdown 还在维护吗？

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