Overleaf Workshop

Open Overleaf (ShareLatex) projects in VSCode, with full collaboration support.

User Guide

The full user guide is available at GitHub Wiki.

Features

[!NOTE] For SSO login or captcha enabled servers like https://www.overleaf.com, please use "Login with Cookies" method. For more details, please refer to How to Login with Cookies.

• Login Server, Open Projects and Edit Files

  

• On-the-fly Compiling and Previewing

  Ctrl+Alt+B to compile, Ctrl+Alt+V preview.

  

• SyncTeX and Reverse SyncTeX

  Ctrl+Alt+J to jump to PDF. Double click on PDF to jump to source code

• Chat with Collaborators

  

• Open Project Locally, Compile/Preview with LaTeX-Workshop

  

How to Login with Cookies

In an already logged-in browser (Firefox for example):

1. Open "Developer Tools" (usually by pressing F12) and switch to the "Network" tab;

   Then, navigate to the Overleaf main page (e.g., https://www.overleaf.com) in the address bar.

2. Filter the listed items with /project and select the exact match.

3. Check the "Cookie" under "Request Headers" of the selected item and copy its value to login.

   The format of the Cookie value would be like: overleaf_session2=... or sharelatex.sid=...

Compatibility

The following Overleaf (ShareLatex) Community Edition docker images provided on Docker Hub have been tested and verified to be compatible with this extension.

• [x] sharelatex/sharelatex:5.0.4 (verified by @Mingbo-Lee)

• [x] sharelatex/sharelatex:4.2.4

• [x] sharelatex/sharelatex:4.1 (verified by @iamhyc)

• [x] sharelatex/sharelatex:3.5 (verified by @iamhyc)

• [ ] sharelatex/sharelatex:3.4

• [ ] sharelatex/sharelatex:3.3

• [ ] sharelatex/sharelatex:3.2

• [ ] sharelatex/sharelatex:3.1

• [ ] sharelatex/sharelatex:3.0

Development

Please refer to the development guidance in CONTRIBUTING.md

References

• Overleaf Official Logos
• Overleaf Web Route List
• James-Yu/LaTeX-Workshop
• jlelong/vscode-latex-basics