第35章 LMQL文档扩展指南

第35章 文档

学习如何扩展 LMQL 文档。

LMQL 的文档随主仓库一起发布，位于 `docs/` 目录下。大部分章节使用 Markdown 编写，部分页面则提供为 Jupyter Notebook 格式。文档还包含项目网站，其中包括功能演示以及展示在首页上的示例代码。

章节

- 语言：提供 LMQL 核心语言及其能力的资源与文档。除语言参考外，这一部分文档采用“指南”风格，通过示例展示 LMQL 的实用功能。 - 模型支持：概述 LMQL 支持的各种模型后端，并说明如何将它们集成到你的工作流中。 - 库：概述 LMQL 标准库。一方面，这包括在 Python 中集成 LMQL 的形式；另一方面，包括 LMQL 自身的标准库（例如 Chat、Output、Actions 等）。 - 开发：介绍如何扩展 LMQL、如何为项目做出贡献，以及如何搭建开发环境。

构建文档

网站的文档构建使用 VitePress，并通过 GitHub Actions 自动构建和部署。若要本地构建文档，可使用以下命令：

```bash # 进入 docs/ 目录 cd docs # 安装依赖 yarn # 运行支持热重载的实时服务器 yarn docs:dev ```