ThierryDeruyttere/slext

Unofficial browser extension for extending the online LaTeX editor Overleaf

SLext

Slext is an unofficial browser extension for extending the online LaTeX editor Overleaf, with features such as tabs, custom themes and easier file navigation with search.

To install

A listing for the extension is maintained in Google Chrome webstore and Firefox Add-ons. The listings are up to date with the master branch on this repository. If you want the latest features of the develop branch, you must install the extension from source. The process is described for Google Chrome and Firefox below.

npm==6.x.x
node==9.x.x

Google Chrome

Download from Chrome webstore or install from source.

To install from source, clone the repository:

git clone git@github.com:hrjakobsen/slext.git
cd slext
npm install
npm run build:chrome

Then in Google Chrome, go to chrome://extensions

Drag the packed chrome extension from the 'packages' directory onto the page to install the extension.

Firefox

Download from Firefox Add-ons or install from source.

To install from source, clone the repository:

git clone git@github.com:hrjakobsen/slext.git
cd slext
npm install
npm run build:firefox

Then in Firefox, go to about:addons

Click on the settings and press 'Install Add-on From File' then select the .xpi file in the packages folder.

Development

The extension is developed for Google Chrome and Firefox, so please ensure that any features you add works in those two browsers. It may also be possible to run the extension in other browsers,

Clone the repository

git clone git@github.com:hrjakobsen/slext.git
cd slext

Install dependencies

npm install

Running

Google Chrome

Run $ npm run dev:chrome and load the dist/chrome-directory into Chrome as an unpacked extension on chrome://extensions → Load unpacked. After making changes to the code it will automatically be compiled, but you need to refresh the extension where you loaded it.

Firefox

Run $ npm run dev:firefox and load the dist/firefox-directory into Firefox as an temporary add-on on about:debugging → This Firefox → Load Temporary Add-on. After making changes to the code it will automatically be compiled, but you need to click "Reload" where you loaded the it.

Building

To build a release of SLext run the following command

npm run build:chrome
# or
npm run build:firefox

The resulting extension will be stored in the packages directory.

Versioning

To increment the version number of manifest.json and package.json, commit the change to git and add a git tag (Github release).

npm run version:patch      // => 0.0.X

or

npm run version:feature    // => 0.X.0

or

npm run version:release    // => X.0.0