jupyterlab/jupyterlab-latex

Name: jupyterlab-latex

Owner: JupyterLab

Description: JupyterLab extension for live editing of LaTeX documents

Created: 2017-10-24 02:12:37.0

Updated: 2018-05-19 20:56:31.0

Pushed: 2018-05-04 21:55:44.0

Homepage:

Size: 312

Language: Python

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

JupyterLab LaTeX

Binder

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

Usage

To use, right-click on an open .tex document within JupyterLab, and select Show LaTeX Preview: 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.

For more advanced usage documentation, see here.

Requirements
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:

install jupyterlab_latex

If you are running Notebook 5.2 or earlier, enable the server extension by running

ter serverextension enable --sys-prefix jupyterlab_latex

To install the lab extension, run

ter labextension install @jupyterlab/latex
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:

texConfig.latex_command = 'pdflatex'

The extension defaults to running bibtex for generating a bibliography if a .bib file is found. You can also configure the bibliography command by setting

texConfig.bib_command = '<custom_bib_command>'
Changes

For information on the changes with different versions of the jupyterlab-latex library, see our changelog


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.