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

katexify

v0.1.0

Published

script to parse html and render math equations server side

Downloads

5

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Maintainers

marcusklaasmarcusklaas

Keywords

katexmathlatexrenderinghtmlpostprocessing

Readme

katexify

Recursively walks a filesystem, katexifying all html files in its path. Turns $...$ spans into inline math, and $$...$$ into display math.

To print regular dollers, they can be escaped with backslashes and will be unescaped. For example: The sum of \$5 and \$3 is \$8 will become The sum of $5 and $3 is $8. To produce a regular backslash before a math span, escape backslash themselves: \\$f(x) = x^2$ will produce \<span class="katex">…</span>. Note that only escaped backslashes immediately preceding a doller will be unescaped. All other escape sequences are untouched.

Example

<html>
    <head>
        <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css" integrity="sha384-dbVIfZGuN1Yq7/1Ocstc1lUEm+AT+/rCkibIcC/OmWo5f0EA48Vf8CytHzGrSwbQ" crossorigin="anonymous">
    </head>
    <body>
        Let $x$ be a variable and $$\Sigma_{i = 0}^n i = \frac{n(n-1)}{2}$$ a formula.
        Also replace when delimiters are on different lines:
        $$
            \Sigma_x {f^2(x)} \leq \left({ \Sigma_x f(x)}\right)^2
        $$
    </body>
</html>

renders to:

example rendered math

Usage

Run test suite:

npm test

Simple usage without installation:

node bin/index.js <dir>

Note that katexify only produces the semantic structure in HTML. To properly render the math, you'll need KaTeX CSS. This can be loaded through a CDN by including

<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css" integrity="sha384-dbVIfZGuN1Yq7/1Ocstc1lUEm+AT+/rCkibIcC/OmWo5f0EA48Vf8CytHzGrSwbQ" crossorigin="anonymous">

in your your HTML. For more information, check the KaTeX browser installation page.

Installation

sudo npm install -g
katexify <dir>