概述

欢迎为文档做出贡献！本指南介绍了如何通过编写和格式化新文档来为 LibreChat 文档做出贡献。该网站基于 Fumadocs 构建，文档使用 .mdx 格式。

何时撰写文档与博客文章

入门指南

• Fork LibreChat Documentation 仓库：https://github.com/LibreChat-AI/librechat.ai

• 在你的 fork 上创建一个分支，为其命名，并将其关联到原始仓库。

git clone -b branch-name https://github.com/username/librechat.ai.git

将 branch-name 和 username 替换为您的详细信息

创建新文档

要创建一个新文档：

• 使用 .mdx 文件扩展名（更多信息请参阅 MDX documentation）。
• 使用小写字母和下划线命名文件（例如 documentation_guidelines.mdx）。
• 将新文档放置在 content/docs 下的相关文件夹/子文件夹中。
• 将文档添加到该文档所在文件夹的 meta.json 文件中的 pages 数组内。如果不添加，Fumadocs 仍然可以发现它，但它不会按预期的顺序出现在侧边栏中。

Markdown 格式指南

• 使用 #、## 和 ### 来使用标题和子标题。
  • 使用 # 作为文档标题（每个文档仅允许存在一个主标题）。
  • 使用 ## 作为主要章节。
  • 在章节内的子章节请使用 ###。
• 使用 ** 来使文本加粗并突出显示重要信息（请勿将其用作标题）。
• 使用 URL 路径链接到其他文档（例如，/docs/documentation 指向当前的 doc）。
• 您可以使用 HTML、TS 和 JS 为文档添加额外功能。
• 请确保所有 HTML 标签均包含闭合标签（例如 <img src="" /> 或 <a href="link"></a>）。
• 不要使用 HTML 注释；如果文本确实需要隐藏，请仅使用 Markdown 注释。

文档资源

文档元数据

使用以下格式将元数据添加到文档的页眉中：

注意：ogImage 字段是可选的，可以完全省略。它用于指定在社交媒体平台上分享您的文档时所显示的图像。

---
title: Document Title
description: This description will be used in social cards and search engine results.
ogImage: /images/docs/<category>/image.png (optional)
---

资源

尽可能将资源（例如图片）上传到 GitHub，而不是存储在 /public 文件夹中。这有助于保持仓库的整洁，并使资源管理更加容易。

图像

对于需要适配当前主题的截图，请使用 ThemeImage 组件。提供 light 和 dark 两种源文件，它会自动渲染与读者主题相匹配的版本。它还像其他所有图片一样，支持点击缩放功能。

在以下位置查看示例的实际效果：用户指南

<ThemeImage
  light="https://github.com/danny-avila/LibreChat/assets/32828263/cf0f3231-287a-407f-bd4d-3d5bad94e893"
  dark="https://github.com/danny-avila/LibreChat/assets/32828263/a03ee02d-5099-4220-95b0-bfa2d3b00b4d"
  alt="LibreChat running on an iPad"
/>

如何在 GitHub 上上传图片和视频

测试文档