文档系统

相关源文件

• .github/workflows/deploy_gh-pages.yml
• docs/css/custom.css
• docs/docs/Develop/Clients/typescript-client.md
• docs/docs/Integrations/Nvidia/integrations-nvidia-g-assist.md
• docs/docusaurus.config.js
• docs/package-lock.json
• docs/package.json
• docs/sidebars.js
• docs/src/components/icon/index.tsx
• docs/src/theme/Footer.js
• docs/static/img/langflow-icon-black-transparent.svg
• docs/static/img/langflow-logo-black.svg
• docs/static/img/langflow-logo-white.svg
• docs/tailwind.config.js
• docs/yarn.lock

文档系统使用 Docusaurus 作为主要文档框架，为 Langflow 提供全面的面向用户的文档。该系统负责内容组织、 API 参考生成、搜索功能、主题化和部署自动化。

有关开发测试和 CI/CD 流程的信息，请参阅测试和 CI/CD 管道。有关部署基础设施和配置，请参阅部署和配置。

架构概述

该文档系统基于 Docusaurus 3.7.0 构建，并集成了多种专业工具，以实现全面的文档生成和管理。

来源： docs/docusaurus.config.js1-384 docs/sidebars.js1-345 docs/package.json1-69 .github/workflows/deploy_gh-pages.yml1-42

配置系统

文档配置集中在docusaurus.config.js中，并管理着站点生成、主题化和集成等所有方面。

核心配置

组件	配置	目的
title	"Langflow Documentation"	站点元数据
tagline	"用于 RAG 和多智能体 AI 的低代码应用程序构建器"	站点描述
url	"https://docs.langflow.cn"	基础 URL
baseUrl	可环境配置	路径配置
organizationName	"langflow-ai"	GitHub 组织
projectName	"langflow"	仓库名称

插件配置

来源： docs/docusaurus.config.js80-291 docs/docusaurus.config.js372-381

OpenAPI 集成

该系统使用docusaurus-preset-openapi从 OpenAPI 规范自动生成 API 文档。

配置	值	目的
api.path	"openapi.json"	OpenAPI 规范文件
api.routeBasePath	"/api"	API 文档 URL 路径
docs.routeBasePath	"/"	主文档位于根目录

来源： docs/docusaurus.config.js85-88

内容组织结构

文档内容通过侧边栏配置进行分层组织，提供逻辑分组和导航。

来源： docs/sidebars.js2-344

侧边栏配置结构

侧边栏被定义为一个带有类别和单个文档的分层 JavaScript 模块

• 类别项：相关文档的 agrupamentos，使用type: "category"
• 文档项：单个页面，使用type: "doc"
• 链接项：外部链接，使用type: "link"
• HTML 项：自定义 HTML 内容，使用type: "html"

来源： docs/sidebars.js4-47 docs/sidebars.js332-342

搜索和导航系统

该文档集成了 Algolia 搜索，提供全文搜索功能并增强了自定义导航。

Algolia 搜索配置

参数	值	目的
appId	"UZK6BDPCVY"	Algolia 应用程序标识符
apiKey	"adbd7686dceb1cd510d5ce20d04bf74c"	公共搜索 API 密钥
indexName	"langflow"	搜索索引名称
contextualSearch	true	上下文感知搜索结果
searchPagePath	"search"	专用搜索页面

来源： docs/docusaurus.config.js372-380

自定义搜索界面

来源： docs/src/theme/Footer.js1-77

主题和样式系统

文档结合使用 Docusaurus 主题、自定义 CSS 和 TailwindCSS，以实现全面的样式控制。

主题配置

组件	配置	目的
colorMode.defaultMode	"light"	默认主题模式
colorMode.disableSwitch	false	允许切换主题
colorMode.respectPrefersColorScheme	true	系统偏好检测
navbar.hideOnScroll	true	导航自动隐藏
docs.sidebar.hideable	false	侧边栏可见性固定

来源： docs/docusaurus.config.js327-348

自定义 CSS 系统

来源： docs/css/custom.css1-419 docs/tailwind.config.js1-17 docs/docusaurus.config.js280-290

响应式设计功能

自定义 CSS 实现了响应式断点，以获得最佳的移动体验

• 移动端搜索宽度调整：767px，500px，380px 断点
• 图片尺寸控制，默认max-width: 600px，并有移动端覆盖
• 侧边栏广告定位和移动端适配

来源： docs/css/custom.css237-254 docs/css/custom.css223-235

构建和部署管道

该文档系统使用 GitHub Actions 进行自动化构建和部署到 GitHub Pages。

构建流程

来源： .github/workflows/deploy_gh-pages.yml1-42

包管理

该文档系统使用 Yarn，并通过 Volta 进行特定的版本管理

工具	版本	目的
Node.js	18.18.0	JavaScript 运行时
Yarn	1.22.19	包管理器
Volta	包管理器版本控制	开发环境一致性

来源： docs/package.json57-61

开发工作流

该文档系统支持内容创建和技术开发工作流。

内容开发

来源： docs/package.json6-12 docs/package.json22-23

TypeScript 集成

该文档系统支持 TypeScript，用于组件开发

• 用于 Docusaurus 类型定义的@docusaurus/module-type-aliases
• 用于 TypeScript 配置的@tsconfig/docusaurus
• 用于类型检查和编译的typescript^5.2.2

来源： docs/package.json36-43