LangChat LogoLangChat Docs

LangChat AI Platform

LangChat Docs让企业文档交付更专业、更清晰、更可持续

LangChat Docs 聚焦企业文档交付场景，连接授权访问、内容呈现与持续运营，帮助团队把文档变成客户服务入口。

LangChat Team 作品

访问产品官网 · langchat.cn

授权功能

按项目授权访问

输入授权码后自动进入可访问项目文档。

在线编辑

Markdown 在线编辑

后台直接编辑内容并实时预览渲染结果。

Git 同步

仓库同步与部署

支持 Pull / Push / Deploy 一体化流程。

日志追溯

登录与授权日志

关键访问行为可记录、可查询、可追溯。

渲染能力

复杂内容统一表达

代码、表格、流程图、提示块完整支持。

持续运营

交付后持续更新

文档可持续维护，沉淀长期客户资产。

案例 01

重点信息难突出，读者经常错过关键提醒

在交付文档中，风险、建议和状态信息如果没有清晰层级，客户很容易漏读关键内容。

  • 支持 Badge 标签区分状态
  • 支持多类型 Callout 强化重点
  • 支持 GitHub 风格提示块语法

Badge 与 Callout 示例

Beta Internal Breaking Change
实践建议

把“先决条件”和“关键参数”放在文档前 20% 的位置。

注意事项

生产环境执行高风险操作前，请先备份。

案例 02

交付细节表达不统一，技术信息传达效率低

代码、参数和矩阵信息如果散落在纯文本里，客户阅读效率低且容易误解。

  • 支持高亮代码块与标题
  • 支持 Markdown 表格和结构化对比
  • 支持引用能力提升上下文连贯性

代码与表格示例

代码 1tsrender-config.ts
export const renderConfig = {
  toc: true,
  mermaid: true,
  math: true
};
模块是否支持备注
代码高亮是支持多语言
Mermaid是支持放大缩小
数学公式是基于 KaTeX

案例 03

流程与模型难直观说明，客户理解成本高

只靠文字描述复杂流程和公式，会增加沟通轮次，影响交付节奏。

  • 支持 Mermaid 流程图渲染
  • 支持时序图表达交互链路
  • 支持行内/块级数学公式

Mermaid 与公式示例

Mermaid
图表组件加载中...

行内公式：F1=2PRP+RF_1 = \frac{2PR}{P + R}

score=∑i=1nwi⋅xiscore = \sum_{i=1}^{n} w_i \cdot x_i

案例 04

多角色读者需要不同视角，单页内容难兼顾

前端、后端、运维关注点不同，文档需要在同页中提供可切换的信息组织方式。

  • 支持 Tabs 切换不同语言示例
  • 支持 Files 形式展示多文件配置
  • 支持 Accordion 控制信息密度

Tabs / Files / Accordion

ts
const message = "LangChat Docs";
console.log(message);
我应该如何组织长文档？

先定义固定目录模板：概述、配置、流程、排障、FAQ。

案例 05

交付过程缺少阶段视图，客户看不到推进节奏

客户不仅关心结果，也关心过程。阶段化表达能显著提升协作透明度。

  • 支持 Cards 展示信息分组
  • 支持 Steps 表达执行路径
  • 支持 Timeline 展示交付进度

Cards / Steps / Timeline

产品文档
用于功能说明与架构介绍
实施手册
用于部署流程与环境配置说明
运维手册
用于故障处理、巡检与升级流程
  1. 定义模板
    统一章节结构与文档规范
  2. 补充示例
    补充代码、图表、表格与截图
  3. 上线运营
    接入授权访问并持续迭代内容

案例 06

接口文档格式不标准，研发与交付沟通反复

接口参数、请求响应、字段模型如果没有统一格式，会让联调效率大幅下降。

  • 支持 Endpoint + Params 结构
  • 支持 Request/Response 示例块
  • 支持 Schema 字段模型展示

API 组件示例

POST/api/docs/renderAuth
请求参数
Body 参数渲染请求主体
contentbody
string必填trueMarkdown 文本
langbody
string可选zh语言标识
RenderResult
返回字段渲染结果模型
ok
boolean必填true请求是否成功
html
string必填true渲染后的 HTML

案例 07

图文展示能力弱，产品价值难以直观传达

在交付场景中，图片与多媒体展示是理解复杂能力的重要方式。

  • 支持 Markdown 图片元信息
  • 支持 image/images 自定义标签
  • 支持图文组合表达

图片与图组示例

图 1标准 Markdown 图片示例LangChat Logo
图 2LangChat LogoLangChat Logo
图 3Logo-1Logo-1 图 4Logo-2Logo-2

LangChat Docs by LangChat Team

想了解完整产品能力与方案，请访问官方网站

打开官网进入文档入口