# @antv/t8 中文文档

规范地址：https://npmcn.com/package/%40antv/t8/

版本：0\.3\.1
npm 元数据更新时间：2026-09-21T08:46:53.983Z
中文译文更新时间：2026-11-06T07:20:58.341Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：800 kB，542 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：4 个
- 首次发布：2025-06-24T07:34:20.946Z
- 最新版本发布：2026-09-04T14:24:23.613Z
- 近 30 天下载量：27148（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：8（近 12 个月 4 个）

## 中文简介

T8是AntV技术堆栈内非结构化数据的文本可视化解决方案,它是一种宣示式的T8标记下语法,可用于描述数据解释报告的内容.

## 安装

```sh
npm install @antv/t8
```

也可以使用：`pnpm add @antv/t8`、`yarn add @antv/t8`、`bun add @antv/t8`

## README

![](https://gw.alipayobjects.com/zos/antfincdn/R8sN%24GNdh6/language.svg) [English](https://npmcn.com/package/%40antv/t8/README.md) | 简体中文

# **🧬 T8：文本数据可视化**

`T8` 是 AntV 技术栈下针对非结构化数据得文本可视化解决方案，其中 `T` 代表 Text，`8` 代表一个字节 8 bits，寓意这个工具可以深度透视文本底下的洞察。

![gzip size](https://img.badgesize.io/https://unpkg.com/@antv/t8/dist/t8.min?compression=gzip) [![Build Status](https://github.com/antvis/t8/actions/workflows/build.yml/badge.svg)](https://github.com/antvis/T8/actions/workflows/build.yml) [![codecov](https://codecov.io/gh/antvis/T8/graph/badge.svg?token=A8fR9pUkbc)](https://codecov.io/gh/antvis/T8) [![npm Version](https://img.shields.io/npm/v/@antv/t8.svg)](https://www.npmjs.com/package/@antv/t8) [![npm License](https://img.shields.io/npm/l/@antv/t8.svg)](https://www.npmjs.com/package/@antv/t8)

`T8` 是一套声明式的 Markdown `Syntax` 语法，可以用它描述数据解读报告的内容。技术方案上，基于 Markdown `Syntax` 数据来自服务端生成的假设，前端消费 Syntax 进行渲染即可。随着数据表达的多样性和即时性的要求越来越高，以及 AI、NLP 技术越来越多的被应用，前端维护文本模版将不可持续，此时使用 T8 进行统一渲染将是最佳选择。

## 📚 文档

-   **[快速开始](https://t8.antv.vision/zh/tutorial/quick-start)** - 几分钟内开始使用 T8，包含安装和基本使用示例
-   **[教程](https://t8.antv.vision/zh/tutorial/quick-start)** - 学习主题、事件、插件、流式渲染和 LLM 集成
-   **[语法](https://t8.antv.vision/zh/syntax/)** - 完整的 T8 语法参考和结构指南
-   **[API 文档](https://t8.antv.vision/zh/api/)** - 详细的 API 文档和使用指南

## ✨ Features

-   🛫 **前端技术栈无关** - 可以在 `React`, `Vue` 或者其他的前端框架中使用，并非常易于封装成组件。
-   🤖 **大语言模型友好** - T8 的 Markdown `Syntax` 描述，近通过简单的提示词，就可以非常容易被大语言模型理解和生成。
-   🛠️ **可扩展** - 可以通过 `EntityPhrase` 来快速的自定义 T8 文本展示的样式。
-   🪩 **轻量级** - 很少的、轻量的依赖，并在代码设计中关注包大小，压缩后小于 `20` Kb。

## 🔨 安装

使用 npm 或 yarn 安装 T8：

```bash
npm install @antv/t8
```

```bash
yarn add @antv/t8
```

## 🚀 快速示例

```js
import { Text } from '@antv/t8';

const text = new Text({ container: 'container' });
text.theme('light').render(`
  # 销售报告
  总销售额达到 [¥1,234,567](metric_value, origin=1234567)。
`);
```

完整的使用示例和高级功能，请参见 **[快速开始指南](https://t8.antv.vision/zh/tutorial/quick-start)**。

## 🤖 在大模型中使用

T8 被设计为对大语言模型友好。T8 语法可以轻松地由 AI 模型生成，使其成为自动化数据叙述生成的理想选择。为了帮助您将 T8 与 AI Agent 集成：

-   **[提示词模板](https://npmcn.com/package/%40antv/t8/prompt.zh-CN.md)** - 可直接使用的 LLM 提示词，用于生成 T8 语法
-   **[LLM 集成指南](https://t8.antv.vision/zh/tutorial/advanced/llm)** - 使用 T8 与大语言模型的完整指南
-   **[示例](https://npmcn.com/package/%40antv/t8/example/example.md)** - T8 语法输出示例

## 📮 Contributing

很期待我们的用户参入到 T8 的开发和反馈，也感谢所有贡献这个项目的开源社区开发者。🙏

-   [Issues](https://github.com/antvis/t8/issues) - 报告 Bug 或者提交 Pull Request
-   [Discussions](https://github.com/antvis/t8/discussions) - 在 GitHub 讨论区讨论想法

## 📄 License

MIT@[AntV](https://github.com/antvis).

## 常见问题

### @antv/t8 是什么？

T8是AntV技术堆栈内非结构化数据的文本可视化解决方案,它是一种宣示式的T8标记下语法,可用于描述数据解释报告的内容\.

### 如何安装 @antv/t8？

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

### @antv/t8 支持 TypeScript 吗？

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

### @antv/t8 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @antv/t8 可以商用吗？

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

### @antv/t8 的下载量有多少？

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

### @antv/t8 还在维护吗？

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