跳转到主要内容
在你的网站、博客或课程页面上放置一个链接。任何点击它的人都会获得一个包含你的文件的、属于自己的新项目。无需任何设置。 访问者需要在你的实例上拥有账号。未登录的访问者会先进入登录页面,登录后项目才会打开。 此功能的页面使用 Overleaf 这个名称。你自己的链接或按钮可以使用任何文字,例如 Open in Ayakaleaf。

查看示例

在你的站点上打开 /devs,例如 https://ayakaleaf.example.com/devs。没有任何菜单链接到此页面,因此请手动输入地址。默认情况下,你必须登录才能查看它。
带有 A LaTeX code snippet 和 A zipped project 按钮的 Overleaf API 页面

Overleaf API 页面

点击 A LaTeX code snippet 或 A zipped project。一个包含该示例的新项目会打开。
项目 I am a Zip file,包含 main.tex、main2.tex 和 sample.bib 及其 PDF

来自压缩包示例的项目

1

构建链接

将文件地址经过 URL 编码后放在 /docs?snip_uri= 之后:
对于压缩的项目,请使用 zip_uri:
你的实例会下载该文件,因此它必须可以通过 HTTP 或 HTTPS 访问。私有网络上的地址会被拒绝,请参阅 External URL。
2

将其添加到你的页面

3

点击链接

新项目会在编辑器中打开,其中只有一个保存为 main.tex 的文件。
编辑器中的项目 Hello from a link,包含 main.tex 及其 PDF

从链接打开的项目

每次点击都会创建另一个项目。该项目是一个副本,因此之后对你的文件所做的更改不会同步到它。
对于小文件,你无需托管任何内容:将其内容作为 Base64 data URL 放入链接中。在 JavaScript 中:
btoa 只接受 Latin-1 字符,因此请先将其他文本编码为 UTF-8。对于压缩的项目,请使用 zip_uri 和 data:application/zip;base64,。 长度超过约 8 KB 的链接会被拒绝,并返回错误 414 Request-URI Too Large。对于更大的内容,请托管文件或使用表单。

选择选项

将以下参数添加到链接中,或作为隐藏字段添加到表单中: 没有 \documentclass 的 .tex 文件会被包装在一个标准文档中,因此可以立即编译:
表单发送的参数与链接相同:
要直接发送 LaTeX 内容,纯文本请使用 snip,经过 encodeURIComponent 处理的文本请使用 encoded_snip。 表单并不总是有效,因此除非你的文件太长无法放入链接,否则链接是更好的选择: 如果管理员设置了 OVERLEAF_ALLOW_PUBLIC_ACCESS=true,在上述所有情况下项目都会打开,必要时先登录。该设置还会向未登录的访问者开放其他页面,请参阅 Page Access。 关于管理员可以设置的其他内容,请参阅 Overleaf Import API。/devs 页面上有更多示例。

如果项目没有打开

页面会说明出了什么问题。View the Overleaf API docs 会带你前往 /devs。
带有消息 invalid url 和 View the Overleaf API docs 按钮的 Open in Overleaf 页面

实例无法使用的链接

最后修改于 2026年11月20日