• 简体中文
  • 快速开始

    在 React 应用中使用 Fluxdown,传入 Markdown 就可以开始渲染。常用语法、代码高亮、复制按钮和基础样式已经准备好。

    安装

    pnpm add fluxdown

    项目需要 React 18 或 19。

    显示第一段内容

    import { Fluxdown } from 'fluxdown';
    
    const markdown = `# 你好,Fluxdown
    
    让正在生成的内容,也能**轻松阅读**。`;
    
    export default function App() {
      return <Fluxdown text={markdown} />;
    }

    如果打包器没有自动加载组件样式,可以在应用的全局样式入口手动引入:

    import 'fluxdown/styles.css';

    接入已有的流式文本

    如果你的请求工具已经提供了累积文本,直接把它传给 text,并用请求状态控制 streaming:

    import { Fluxdown } from 'fluxdown';
    
    type MessageProps = {
      text: string;
      isStreaming: boolean;
    };
    
    export function Message({ text, isStreaming }: MessageProps) {
      return <Fluxdown streaming={isStreaming} text={text} />;
    }

    text 始终是当前完整内容。请求完成后把 streaming 设为 false,即可显示完整结果并结束流式效果。

    下一步