Code Monkey home page Code Monkey logo

jupyterlab-katex's Introduction

jupyterlab-katex

WARNING

This repository is deprecated. It has been moved to the jupyter-renderers repository.

An extension for JupyterLab that provides KaTeX rendering for math.

The default LaTeX renderer in JupyterLab uses MathJax, which, while powerful, can be slow to render complex equations. This extension substitutes the MathJax renderer with the KaTeX renderer. KaTeX is much faster, at the cost of being less full-featured than MathJax. If you want faster math processing and the subset of LaTeX provided by KaTeX is sufficient for your purposes, this may be the extension for you!

If you equations are not rendering properly with this extension, you probably will want to fall back to MathJax.

Prerequisites

  • JupyterLab 0.28

Installation

To install this extension into JupyterLab (requires node 5 or later), enter the following in your terminal:

jupyter labextension install jupyterlab-katex

Development

From the jupyterlab-katex directory, run

npm install
npm run build
jupyter labextension link .

You can then watch the src directory for changes by running

npm run watch

Launch JupyterLab in watch mode (jupyter lab --watch), and it wil automatically pick up changes to the built assets of this extension and rebuild the application.

jupyterlab-katex's People

Contributors

ian-r-rose avatar

Stargazers

Samuel Lelièvre avatar Jacob Quinn Shenker avatar Ales Kuchar avatar Bater.Makhabel avatar mg20400 avatar Izaak "Zaak" Beekman avatar Juan Luis Cano Rodríguez avatar

Watchers

James Cloos avatar  avatar  avatar

jupyterlab-katex's Issues

Add a test suite

It is probably out-of-scope to test specific functionality of KaTeX, but we can just make something that verifies that the render function executes without error.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.