npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

notebookjs-katex

v1.1.0

Published

Process embedded math expressions in IPython Markdown cells.

Downloads

7

Readme

CI License: MIT

Overview

IPython Markdown cells can format LaTeX math expressions between $...$ (inline) or $$...$$ (block) delimiters. This works great when editing and viewing within a Jupyter process. However, when converting the source *.ipynb file to HTML using the otherwise excellent notebookjs package the math expressions do not appear -- notebookjs does not currently support expansion of $...$ and $$...$$ expressions into math HTML renderings.

NOTE: currently the delimiters are hard–coded. Customizing this is work for a future release.

This NPM package provides a simple filter for IPython source which when run before notebookjs's render process will properly generate inline and block math HTML expressions using the KaTeX package. I use this to perform server-side math expression rendering for my blog, Keystroke Countdown.

To Use

Install this package using npm:

% npm install [-s] notebookjs-katex

Assuming you already have notebookjs installed, one way for using this would like so, just prior to using notebookjs to parse and render HTML:

var KatexFilter = require("notebookjs-katex");
var kf = new KatexFilter();

var ipynb = JSON.parse(fs.readFileSync('/path/to/notebook.ipynb'));
kf.expandKatexInNotebook(ipynb);

var notebook = notebookjs.parse(ipynb);
var html = notebook.render().outerHTML;

Configuration

The KatexFilter constructor takes an optional configuration object which will be given to the KaTeX render method. See the docs for details. Note that KatexFilter always sets throwOnError to false, and displayMode will be set depending on the delimiters surrounding the math expression.

Dependencies

  • jsonpath -- used to isolate the Markdown cells in an IPython notebook JSON file.
  • KaTeX -- performs the rendering of the LaTeX commands.

Tests

There are a set of Vows in index.test.js. To run:

% npm test

NOTE: if this fails, there may be a path issue with vows executable. See package.json.