Semantic Researcher Overleaf

Open Overleaf (ShareLaTeX) projects in VS Code with local replica workflows tuned for semantic-researcher use.

This extension is a fork of Overleaf Workshop. It keeps the upstream AGPL-3.0 license and original contributor credits while carrying local workflow fixes for this fork.

User Guide

The upstream 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

Use Open Project Locally ... to create a replica under a parent folder, or Select Project Folder Locally ... to use an exact folder as the replica root while keeping the current VS Code window and activating local Overleaf features against that folder.

Choose Login in Browser from the login method list. The extension opens a Chrome, Edge, or Chromium window and navigates to the Overleaf project page, which shows the login page when needed. Sign in there as usual, including Google, SSO, or two-factor authentication. Once Overleaf reaches the project page, the extension reads the browser session cookies and completes the same cookie login flow automatically.

In a local VS Code window, no extra extension is needed. In a VS Code Remote window, install Semantic Researcher Overleaf Remote Pack locally so the remote extension can ask your desktop VS Code to open the local browser. For VSIX installs, install the main extension in the remote window and the Remote Pack VSIX in the local desktop VS Code. If the browser is not found automatically, set overleaf-workshop.auth.browserPath for the main extension or semantic-researcher-overleaf-remote-pack.browserPath for the Remote Pack.

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

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.
Filter the listed items with /project and select the exact match.
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

Semantic Researcher Overleaf

alex6095