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

parse-katex

v0.3.0

Published

Parses all math sections inside HTML code with KaTeX.

Downloads

34

Readme

parse-katex

Build Status

Parses all HTML code and renders all LaTeX code (by default marked by $ ... $ for inline equations, and $$ ... $$ for display mode) to properly formatted expressions using KaTeX.

The benefit to using this package is you can pre-render all math content (when it is called from the database for instance) and serve it to the user as pure HTML, which is faster, doesn't cause the page to flicker/rearrange on load, and doesn't need them to have JavaScript enabled.

There is also an Express.js template engine for serving views in an Express app.

To install, run npm install --save parse-katex.

Then, to use simply include it, and then call the function renderLaTeX(code, [config]) (or render which is an alias) like such:

var katex = require('parse-katex');
var console = require('console');
    
console.log(katex.renderLaTeX("<p>This is a sentence with an equation $a^2 + b^2 = c^2$</p>"));

On the user facing page, you still need to include the KaTeX CSS file (you don't need to include the KaTeX JavaScript file) to cause it to render properly. You can include it like this:

<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/KaTeX/0.2.0/katex.min.css">

You can custom the delimiters that are used to render the code by specifying them in the config section as such:

var config = [['~~', '\~\~', true], ['~', '\~', false]]
var parsedHTML = katex.render('<p>This is a test sentence with an equation ~a^2 = 99~.</p>', config)

Note that to use custom delimiters you need to specify an array in order of which they will evaluate (usually you want to evaluate the display mode math first if it is double the symbol of the inline math), and specify the delimiter, the escaped version of the delimiter, and a boolean specifying whether you want to render it as display (true) or inline (false) math.

To use the Express.js template engine, simply use the katex.templateEngine function to declare the engine. The following example shows a minimal setup to render KaTeX in html files (note that the stylesheet is automatically appended to the head when using the template engine so there is no need to include it manually).

var express = require('express');
var katex = require('parse-katex');

var app = express();

app.engine('html', katex.templateEngine);
app.set('view engine', 'html');

app.get('/', function(req, res, next) {
  return res.render('index');
});

app.listen(3000);