JupyterLab LaTeX

An extension for JupyterLab which allows for live-editing of LaTeX documents.

Usage

To use, right-click on a .tex document within JupyterLab, and select Show LaTeX Preview. This will compile the .tex file and open the rendered PDF document. Subsequent saves of the file will automatically update the PDF. If the PDF fails to compile (possibly due to a syntax error), an error panel will open detailing the LaTeX error.

Requirements

• JupyterLab 0.31
• An application that can compile .tex files to PDF on your notebook server (e.g., pdflatex or xelatex).

Installation

This extension includes both a notebook server extension (which interfaces with the LaTeX compiler) and a lab extension (which provides the UI for the LaTeX preview). In order to use it, you must enable both of them.

To install the server extension, run the following in your terminal:

pip install jupyterlab_latex

To install the lab extension, run

jupyter labextension install jupyterlab-latex

Installing from source

You can also install from source in order to develop the extension.

From the jupyterlab-latex directory, enter the following into your terminal:

pip install .
jupyter serverextension enable jupyterlab_latex

This installs the server extension.

Then, to install the lab extension, run

jlpm install
jlpm run build
jupyter labextension install .

Customization

The extension defaults to running xelatex on the server. This command may be customized (e.g., to use pdflatex instead) by customizing your jupyter_notebook_config.py file:

c.LatexConfig.latex_command = 'pdflatex'