Ant Design X
Build excellent AI interfaces and pioneer intelligent new experiences.
[![CI status][github-action-image]][github-action-url] [![codecov][codecov-image]][codecov-url] ![GitHub contributors][github-contributors] [![Follow zhihu][zhihu-image]][zhihu-url]
| Package | Latest Version | Download stats | Bundle Size | JSDelivr |
| :-- | :-- | :-- | :-- | :-- |
| `@ant-design/x` | [![npm version][x-version-image]][x-version-url] | [![npm downloads][x-downloads-image]][x-downloads-url] | [![bundle size][x-bundle-size-image]][x-bundle-size-url] | [![jsdelivr][x-jsdelivr-image]][x-jsdelivr-url] |
| `@ant-design/x-markdown` | [![npm version][x-markdown-version-image]][x-markdown-version-url] | [![npm downloads][x-markdown-downloads-image]][x-markdown-downloads-url] | [![bundle size][x-markdown-bundle-size-image]][x-markdown-bundle-size-url] | [![jsdelivr][x-markdown-jsdelivr-image]][x-markdown-jsdelivr-url] |
| `@ant-design/x-sdk` | [![npm version][x-sdk-version-image]][x-sdk-version-url] | [![npm downloads][x-sdk-downloads-image]][x-sdk-downloads-url] | [![bundle size][x-sdk-bundle-size-image]][x-sdk-bundle-size-url] | [![jsdelivr][x-sdk-jsdelivr-image]][x-sdk-jsdelivr-url] |
[Changelog](./CHANGELOG.en-US.md) · [Report a Bug][github-issues-bug-report] · [Request a Feature][github-issues-feature-request] · English · [中文](./README-zh_CN.md)
[x-version-image]: https://img.shields.io/npm/v/@ant-design/x.svg?style=flat-square
[x-version-url]: https://www.npmjs.com/package/@ant-design/x
[x-downloads-image]: https://img.shields.io/npm/dm/@ant-design/x.svg?style=flat
[x-downloads-url]: https://www.npmjs.com/package/@ant-design/x
[x-bundle-size-image]: https://img.shields.io/bundlephobia/minzip/@ant-design/x
[x-bundle-size-url]: https://bundlephobia.com/result?p=@ant-design/x
[x-package-size-image]: https://packagephobia.com/badge?p=@ant-design/x
[x-package-size-url]: https://packagephobia.com/result?p=@ant-design/x
[x-jsdelivr-image]: https://data.jsdelivr.com/v1/package/npm/@ant-design/x/badge
[x-jsdelivr-url]: https://www.jsdelivr.com/package/npm/@ant-design/x
[x-markdown-version-image]: https://img.shields.io/npm/v/@ant-design/x-markdown.svg?style=flat
[x-markdown-version-url]: https://www.npmjs.com/package/@ant-design/x-markdown
[x-markdown-downloads-image]: https://img.shields.io/npm/dm/@ant-design/x-markdown.svg?style=flat
[x-markdown-downloads-url]: https://www.npmjs.com/package/@ant-design/x-markdown
[x-markdown-bundle-size-image]: https://img.shields.io/bundlephobia/minzip/@ant-design/x-markdown
[x-markdown-bundle-size-url]: https://bundlephobia.com/result?p=@ant-design/x-markdown
[x-markdown-package-size-image]: https://packagephobia.com/badge?p=@ant-design/x-markdown
[x-markdown-package-size-url]: https://packagephobia.com/result?p=@ant-design/x-markdown
[x-markdown-jsdelivr-image]: https://data.jsdelivr.com/v1/package/npm/@ant-design/x-markdown/badge
[x-markdown-jsdelivr-url]: https://www.jsdelivr.com/package/npm/@ant-design/x-markdown
[x-sdk-version-image]: https://img.shields.io/npm/v/@ant-design/x-sdk.svg?style=flat
[x-sdk-version-url]: https://www.npmjs.com/package/@ant-design/x-sdk
[x-sdk-downloads-image]: https://img.shields.io/npm/dm/@ant-design/x-sdk.svg?style=flat
[x-sdk-downloads-url]: https://www.npmjs.com/package/@ant-design/x-sdk
[x-sdk-bundle-size-image]: https://img.shields.io/bundlephobia/minzip/@ant-design/x-sdk
[x-sdk-bundle-size-url]: https://bundlephobia.com/result?p=@ant-design/x-sdk
[x-sdk-package-size-image]: https://packagephobia.com/badge?p=@ant-design/x-sdk
[x-sdk-package-size-url]: https://packagephobia.com/result?p=@ant-design/x-sdk
[x-sdk-jsdelivr-image]: https://data.jsdelivr.com/v1/package/npm/@ant-design/x-sdk/badge
[x-sdk-jsdelivr-url]: https://www.jsdelivr.com/package/npm/@ant-design/x-sdk
[npm-image]: https://img.shields.io/npm/v/@ant-design/x.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@ant-design/x
[github-action-image]: https://github.com/ant-design/x/actions/workflows/main.yml/badge.svg
[github-action-url]: https://github.com/ant-design/x/actions/workflows/main.yml
[codecov-image]: https://codecov.io/gh/ant-design/x/graph/badge.svg?token=wrCCsyTmdi
[codecov-url]: https://codecov.io/gh/ant-design/x
[download-image]: https://img.shields.io/npm/dm/@ant-design/x.svg?style=flat-square
[download-url]: https://npmjs.org/package/@ant-design/x
[bundlephobia-image]: https://badgen.net/bundlephobia/minzip/@ant-design/x?style=flat-square
[bundlephobia-url]: https://bundlephobia.com/package/@ant-design/x
[github-issues-bug-report]: https://github.com/ant-design/x/issues/new?template=bug-report.yml
[github-issues-feature-request]: https://github.com/ant-design/x/issues/new?template=bug-feature-request.yml
[antd-image]: https://img.shields.io/badge/-Ant%20Design-blue?labelColor=black&logo=antdesign&style=flat-square
[antd-url]: https://ant.design
[zhihu-image]: https://img.shields.io/badge/-Ant%20Design-white?logo=zhihu
[zhihu-url]: https://www.zhihu.com/column/c_1564262000561106944
[github-contributors]: https://img.shields.io/github/contributors-anon/ant-design/x
## 🌈 Enterprise-level LLM Components Out of the Box
`@ant-design/x` provides a rich set of atomic components for different interaction stages based on the RICH interaction paradigm, helping you flexibly build your AI applications. See details [here](../x/README.md).
## ⚡️ Connect to Model Agents & Efficiently Manage Data Streams
`@ant-design/x-sdk` provides a set of utility APIs to help developers manage AI application data streams out of the box. See details [here](../x-sdk/README.md).
## ✨ Markdown Renderer
`@ant-design/x-markdown` aims to provide a streaming-friendly, highly extensible, and high-performance Markdown renderer. It supports streaming rendering of formulas, code highlighting, mermaid, and more. See details [here](../x-markdown/README.md).
## Who's using
Ant Design X is widely used in AI-driven user interfaces within Ant Group. If your company or product uses Ant Design X, feel free to leave a message [here](https://github.com/ant-design/x/issues/126).
## Local Development
> antx uses [npm-workspace](https://docs.npmjs.com/cli/v11/using-npm/workspaces) to organize code. We recommend using npm or [utoo](https://github.com/umijs/mako/tree/next) for local development.
```bash
# Install utoo
$ npm i -g utoo
# Install project dependencies (by utoo)
$ ut [install]
# Start project
$ ut start # Method 1: Start via main package script
$ ut start --workspace packages/x # Method 2: Start via workspace param
$ ut start --workspace @ant-design/x # Method 3: Start via package.name (utoo only)
$ cd packages/x && ut start # Method 4: Enter subpackage dir and start
# Add dependency
$ ut install [pkg@version] # Add to main package
$ ut install [pkg@version] --workspace packages/x # Add to subpackage
$ cd packages/x && ut install [pkg@version] # Add to subpackage
# Update dependencies
$ ut update # utoo only
```
## How to Contribute
Before participating in any form, please read the [Contributor Guide](https://github.com/ant-design/ant-design/blob/master/.github/CONTRIBUTING.md). If you wish to contribute, feel free to submit a [Pull Request](https://github.com/ant-design/ant-design/pulls) or [report a Bug](http://new-issue.ant.design/).
> We highly recommend reading [How To Ask Questions The Smart Way](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way), [How to Ask Questions in Open Source Community](https://github.com/seajs/seajs/issues/545), [How to Report Bugs Effectively](http://www.chiark.greenend.org.uk/%7Esgtatham/bugs.html), and [How to Submit Unanswerable Questions to Open Source Projects](https://zhuanlan.zhihu.com/p/25795393). Better questions are more likely to get help.
## Community Support
If you encounter problems during use, you can seek help through the following channels. We also encourage experienced users to help newcomers through these channels.
When asking questions on GitHub Discussions, it is recommended to use the `Q&A` tag.
1. [GitHub Discussions](https://github.com/ant-design/x/discussions)
2. [GitHub Issues](https://github.com/ant-design/x/issues)