Overleaf Workshop 使用教程
1. 项目介绍
Overleaf Workshop 是一个开源项目,旨在帮助用户在 Visual Studio Code (VSCode) 中打开 Overleaf (或 ShareLaTeX) 项目,并支持完整的协作功能。该项目利用了 Overleaf 的在线协作编辑能力,同时提供了本地编译和预览功能,大大提高了 LaTeX 文档的编写效率。
2. 项目快速启动
以下是在本地环境中快速启动 Overleaf Workshop 的步骤:
首先,确保您的系统中已经安装了 Node.js 和 Visual Studio Code。
-
克隆项目到本地文件夹:
git clone https://github.com/iamhyc/Overleaf-Workshop.git
-
进入项目文件夹:
cd Overleaf-Workshop
-
安装项目依赖:
npm install
-
在 VSCode 中打开项目文件夹,然后安装 Overleaf Workshop 扩展。您可以通过扩展市场搜索
Overleaf Workshop
来安装。 -
配置 Overleaf 登录信息。您需要从 Overleaf 官网复制
Cookie
信息,然后在其设置中配置该信息。
3. 应用案例和最佳实践
登录服务器、打开项目和编辑文件
在配置好 Overleaf 登录信息后,您可以通过扩展直接登录 Overleaf 服务器,并打开您的项目进行编辑。
实时编译和预览
在编辑 LaTeX 文档时,您可以按下 Ctrl + Alt + B
来编译文档,Ctrl + Alt + V
来预览文档。
SyncTeX 和反向 SyncTeX
使用 Ctrl + Alt + J
可以跳转到 PDF 对应的位置。双击 PDF 文件也可以跳转到源代码的相应位置。
与协作者聊天
Overleaf Workshop 支持与协作者实时聊天,方便团队协作。
4. 典型生态项目
Overleaf Workshop 与以下 Overleaf (ShareLaTeX) 社区版 Docker 镜像兼容:
sharelatex/sharelatex:5.0.4
sharelatex/sharelatex:4.2.4
sharelatex/sharelatex:4.1
sharelatex/sharelatex:3.5
sharelatex/sharelatex:3.4
sharelatex/sharelatex:3.3
sharelatex/sharelatex:3.2
sharelatex/sharelatex:3.1
sharelatex/sharelatex:3.0
这些镜像已经经过测试,可以确保 Overleaf Workshop 的正常使用。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考