Files
LangBot/README.md
T

1.5 KiB
Raw Blame History

LangBot 官方文档

此仓库是 LangBot 的文档仓库,代码仓库:
LangBot 代码仓库
这是 LangBot 4.0 的文档,3.0 文档请见 v3 分支

参与编写

文档使用 Fumapress 和 Fumadocs 生成,本地开发需要 Node.js 24 或更高版本。

Clone 本仓库,在目录下执行以下命令安装依赖:

npm ci

完成后即可修改文档,修改完后使用以下命令本地启动预览:

npm run dev

使用图片

把图片放到 images 目录下,然后在文档中使用绝对路径引用(相对于项目根目录),如:

![image](/images/xxx.png)

部署细节

文档构建为 dist/public 下的静态站点,并托管在 Cloudflare Pages。部署前会运行类型检查、文档契约测试及完整静态构建。

一些规范化标准

  • 文件夹和文件的命名:一律使用全小写,单词直接-隔开,如plugin-intro.mdx
  • 子文件(夹)的命名,不加前缀(即文件夹的名称),如:deploy文件夹下的,文件夹langbot,langbot文件夹下的manual文件称之为manual.mdx
  • 文档文件格式统一使用 .mdx;构建脚本会把现有 Mintlify 兼容组件转换为 Fumadocs 可渲染格式。
  • 在 docs.json 中配置侧边栏导航结构。

English README