Installation and usage

[hgjuk]

Hi, how is this plugin installed? Do you just need to add the browser extension? Does this work on self-hosted Overleaf instances or only on overleaf.com?

Thanks for any answers!

[superle3]

(I really should make an icon already and publish this)

Does this work on self-hosted Overleaf instances or only on overleaf.com?

It works on overleaf.com and any self-hosted Overleaf instance that has commit overleaf/overleaf@2e82852 created at the 18th of June 2025 ( that also didn't delete the third-party extension support in services/web/frontend/js/features/source-editor/extensions/third-party-extensions.ts).

Hi, how is this plugin installed? Do you just need to add the browser extension?

Yes, for firefox-based browsers if you download the .xpi file of the latest release with the firefox you want to install it, it should prompt you to install the addon.

For chromium-based browsers,

• you have to download the .zip file from the latest release
• unzip it into a folder
• go to chrome://extensions or open your extensions settings. (the url chrome://extensions might get redirected to <insert-browser-name>//extensions)
• turn on developer mode see image below
• click load unpacked see image below
• select the folder into which you unzipped the .zip file. That folder should have a manifest.json in it. And then you're done.

If the installation went well, there should be a little popup on the upper right saying Snippetleaf settings updated when you reload your overleaf tab.

[hgjuk]

Thank you for the reply!

I have an instance of the Overleaf-toolkit running. It seems like the mentioned commit is not in that release? Could I adjust the Overleaf instance I have, or do I need to install a different version?

[superle3]

I am not familiar with docker so I am not sure if this is the best way to do it, but running the following

#!/bin/bash
set -e

echo "Copying patched file..."
docker cp ./bundle.ts sharelatex:/overleaf/services/web/frontend/js/features/source-editor/extensions/bundle.ts
echo "Starting container..."
./bin/up -d

echo "checking bundle.ts"

./bin/docker-compose exec sharelatex bash -c "cat /overleaf/services/web/frontend/js/features/source-editor/extensions/bundle.ts"

echo "Downloading assets..."
./bin/docker-compose exec sharelatex bash -c "cd /overleaf/services/web && npm install --include=dev"
echo "Rebuilding assets..."
./bin/docker-compose exec sharelatex bash -c "cd /overleaf/services/web && npm run webpack:production"

echo "Committing new image sharelatex/sharelatex:5.5.51"
docker commit sharelatex sharelatex/sharelatex:5.5.51

./bin/down
echo "Done. You can now run 'bin/up -d' to start the patched version."

works for me.
Where ./bundle.ts is the updated bundle.ts file.
You'll also need to update your config/version file to 5.5.51

import { syntaxTree } from "@codemirror/language";
import {
  ChangeSet,
  EditorSelection,
  Prec,
  StateEffect,
  StateField,
} from "@codemirror/state";
import {
  Decoration,
  EditorView,
  hoverTooltip,
  keymap,
  ViewPlugin,
  WidgetType,
} from "@codemirror/view";
import {
  undo,
  redo,
  invertedEffects,
  isolateHistory,
} from "@codemirror/commands";
import { CodeMirror, Vim, getCM } from "@replit/codemirror-vim";
export default {
  ChangeSet,
  Decoration,
  EditorSelection,
  EditorView,
  Prec,
  StateEffect,
  StateField,
  ViewPlugin,
  WidgetType,
  hoverTooltip,
  keymap,
  syntaxTree,
  undo,
  redo,
  invertedEffects,
  isolateHistory,
};

export const CodeMirrorVim = {
  CodeMirror,
  Vim,
  getCM,
};

or do I need to install a different version?

The snippet engine can't function without these objects, the concealment and highlighting brackets might work without,
but I don't want to support that.