https://github.com/proffan/latex_envs

(some) LaTeX environments for Jupyter notebook
https://github.com/proffan/latex_envs

Last synced: about 1 month ago
JSON representation

(some) LaTeX environments for Jupyter notebook

• Host: GitHub
• URL: https://github.com/proffan/latex_envs
• Owner: ProfFan
• Created: 2015-11-18T02:56:14.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2015-11-05T20:42:29.000Z (about 9 years ago)
• Last Synced: 2024-04-19T17:22:53.931Z (8 months ago)
• Language: JavaScript
• Homepage:
• Size: 6.77 MB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# (some) LaTeX environments for Jupyter notebook

This extension for IPython 3.x or Jupyter enables to use some LaTeX commands and environments in the notebook's markdown cells. 

1. **LaTeX commands and environments**

 - support for some LaTeX commands within markdown cells, *e.g.* `\textit`, `\textbf`, `\underline`

 -  support for **theorems-like environments**

 -  support for **lists**: *enumerate, itemize*,  

 -  limited support for a **figure environment**,

 -  support for an environment *listing*,

 -  additional *textboxa* environment

2. **Citations and bibliography**

 -  support for `\cite` with creation of a References section, rendering of references can be customized (to some extent)

3. **Document-wide numbering of equations, support for `\label` and `\ref`**

4. **Configuration toolbar**

5. Styles can be customized in the *latex\_env.css* stylesheet

More environments can be simply added in the source file (`thmsInNb4.js`). 

The `conversion` directory contains scripts for converting the notebooks to html and LaTeX while taking into account the structures 

enabled by the extension. Theses scripts require nodejs, perl, ipython3. Examples of such conversions are in the `doc` subdirectory that constains an example notebook and its html and pdf versions. This serves as the documentation.

# Demo/documentation 

A demo notebook `latex_env_doc.ipynb` is provided. Its html version is [latex_env_doc.html](https://rawgit.com/jfbercher/latex_envs/master/doc/latex_env_doc.html) and a pdf resulting 

from conversion to LaTeX is available as [documentation](https://rawgit.com/jfbercher/latex_envs/master/doc/latex_env_doc.html). 

# Installation

You should follow the instructions in the wiki. 

- Manual installation: Clone the repository and then copy the files to  

the notebook extension directory, usually ~/.local/share/jupyter/nebextensions (Jupyter) or ~/.ipython/nbextensions (IPython 3.x).   

Copy the scripts in conversion/ to some directory (preferably in your path).

- Automated installation

An even more simple procedure is to issue

```

jupyter nbextension install https://rawgit.com/jfbercher/latex_envs/master/latex_envs.zip  --user

```

at the command line.

Either load the extension from your `custom.js` or use a code cell with

	%%javascript

	require("base/js/utils").load_extensions("latex_envs/latex_envs")

You can automatically load the extension via

	jupyter nbextension enable latex_envs/latex_envs	

# Disclaimer, sources and acknowledgments

Code certainly needs improvements. **Contributions, comments, issues are most welcome and will be deeply appreciated.**

The original idea and starting code come from a discussion here: [https://github.com/benweet/stackedit/issues/187](https://github.com/benweet/stackedit/issues/187). Examples and code from [https://github.com/ipython-contrib/IPython-notebook-extensions](https://github.com/ipython-contrib/IPython-notebook-extensions) were also used. The bibliography part was inspired by the nice extension  [icalico-document-tools](https://bitbucket.org/ipre/calico/downloads/).