# @comark/ansi 中文文档

规范地址：https://npmcn.com/package/%40comark/ansi/

版本：0\.9\.0
npm 元数据更新时间：2026-11-06T14:15:36.056Z
中文译文更新时间：2026-11-10T11:52:05.772Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40comark/ansi
原文对照：https://npmcn.com/package/%40comark/ansi/?lang=original
项目主页：https://comark.dev/rendering/ansi
源码仓库：https://github.com/comarkdown/comark

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

- 包体积（解压后）：39.8 kB，105 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：katex \>=0\.18\.7，shiki ^4\.5\.0，beautiful-mermaid \>=1\.1\.3
- 首次发布：2026-03-23T16:32:26.515Z
- 最新版本发布：2026-11-06T14:15:35.674Z
- 近 30 天下载量：3875（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：15（近 12 个月 15 个）

## 中文简介

Comark的ANSI终端渲染器. 带有组件的Render Markdown作为CLIs的样式终端输出.

## 安装

```sh
npm install @comark/ansi
```

也可以使用：`pnpm add @comark/ansi`、`yarn add @comark/ansi`、`bun add @comark/ansi`

## README

![Comark banner](https://github.com/comarkdown/comark/blob/main/assets/banner.jpg)

# @comark/ ansi (英语)

[![npm version](https://img.shields.io/npm/v/@comark/ansi?color=black)](https://npmx.dev/@comark/ansi) [![npm downloads](https://img.shields.io/npm/dm/@comark/ansi?color=black)](https://npm.chart.dev/@comark/ansi) [![CI](https://img.shields.io/github/actions/workflow/status/comarkdown/comark/ci.yml?branch=main&color=black)](https://github.com/comarkdown/comark/actions/workflows/ci.yml) [![Documentation](https://img.shields.io/badge/Documentation-black?logo=readme&logoColor=white)](https://comark.dev/rendering/ansi) [![license](https://img.shields.io/github/license/comarkdown/comark?color=black)](https://github.com/comarkdown/comark/blob/main/LICENSE)

ANSI 终端渲染器 [标记](https://comark.dev/). Render markdown 作为CLI,脚本和开发者工具的样式终端输出.

## 特征

-   终端的 ANSI 类输出
-   🌈 尊重 `NO_COLOR` 自动
-   HR 和代码块的可配置终端宽度
-   将任何 Comark 标记映射到自定义渲染函数
-   QQ 插件生态系统( 美人鱼、 突出、 绑定... )
-   QQ 全类型脚本支持

## 安装

```bash
npm install @comark/ansi
# or
pnpm add @comark/ansi
```

## 使用量

```ts
import { renderAnsi } from '@comark/ansi'

const output = await renderAnsi(`
# Getting Started

This is a **bold** statement with a [link](https://example.com).

- Item 1
- Item 2
`)

process.stdout.write(output)
```

### 选项

```ts
await renderAnsi(content, {
  colors: true,   // emit ANSI escape codes (defaults to true, false when NO_COLOR is set)
  width: 80,      // terminal width for HR and code block headers
  plugins: [],
  components: {},
})
```

### 语法突出显示

```ts
import { renderAnsi } from '@comark/ansi'
import shiki from '@comark/ansi/plugins/shiki'

const output = await renderAnsi('```ts\nconsole.log("hi")\n```', {
  plugins: [shiki()],
})
```

## API 密码

-   `renderAnsi(markdown, options?)` 解析并让 Markdown 变成 ANSI 字符串 .
-   `createAnsiRenderer(options?)` 创建可重复使用的剖析和递归函数.
-   `renderAnsiFromDocument(document, options?)` 使预分解 `MarkdownDocument`。 。 。 .
-   `printAnsi(markdown, options?)` 解析并写入 Markdown 到 `process.stdout` 或习惯 `writer`. (中文(简体) )`writeAnsi` 是被贬损的别名。 )
-   `createAnsiPrinter(options?)` 创建可重复使用的打印机 。 ()`createAnsiWriter` 是被贬损的别名。 )

```ts
import { createAnsiPrinter } from '@comark/ansi'

const printAnsi = createAnsiPrinter({
  colors: false,
  writer: (output) => process.stderr.write(output),
})

await printAnsi('# Build complete')
```

## 文档

完整指南和 API 参考 [comark.dev/refersing/ansi(签名)](https://comark.dev/rendering/ansi)。 。 。 .

## 许可证

由 所制

原载 [MIT 许可证](https://github.com/comarkdown/comark/blob/main/LICENSE)。 。 。 .

## 常见问题

### @comark/ansi 是什么？

Comark的ANSI终端渲染器\. 带有组件的Render Markdown作为CLIs的样式终端输出\.

### 如何安装 @comark/ansi？

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

### @comark/ansi 支持 TypeScript 吗？

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

### @comark/ansi 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @comark/ansi 可以商用吗？

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

### @comark/ansi 的下载量有多少？

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

### @comark/ansi 还在维护吗？

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