Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
KaTeX is a fast, easy-to-use JavaScript library for TeX math rendering on the web. It provides a way to display mathematical notation in web pages, supporting a wide range of TeX functions and symbols.
Render TeX to HTML
This feature allows you to convert TeX expressions into HTML. The `renderToString` method takes a TeX string and returns an HTML string that can be inserted into a web page.
const katex = require('katex');
const html = katex.renderToString('c = \pm\sqrt{a^2 + b^2}');
console.log(html);
Render TeX to DOM
This feature allows you to render TeX expressions directly into a DOM element. The `render` method takes a TeX string and a DOM element, and it updates the element's content with the rendered math.
const katex = require('katex');
const element = document.getElementById('math');
katex.render('E = mc^2', element);
Auto-render TeX in HTML
This feature automatically finds and renders all TeX expressions within a given DOM element. The `renderMathInElement` function scans the element for TeX expressions and replaces them with rendered math.
const katex = require('katex');
const renderMathInElement = require('katex/contrib/auto-render');
renderMathInElement(document.body);
MathJax is another popular JavaScript library for displaying mathematical notation in web pages. It supports a wider range of input formats, including TeX, MathML, and AsciiMath. MathJax is known for its high-quality rendering and extensive configurability, but it is generally slower than KaTeX.
AsciiMath is a simpler alternative to KaTeX and MathJax, designed for ease of use. It uses a more human-readable syntax compared to TeX. While it is easier to write and understand, it does not support as many advanced mathematical features as KaTeX or MathJax.
KaTeX is a fast, easy-to-use JavaScript library for TeX math rendering on the web.
KaTeX supports all major browsers, including Chrome, Safari, Firefox, Opera, and IE 8 - IE 11.
Download the built files from the releases page. Include the katex.min.js
and katex.min.css
files on your page:
<link rel="stylesheet" type="text/css" href="/path/to/katex.min.css">
<script src="/path/to/katex.min.js" type="text/javascript"></script>
Call katex.render
with a TeX expression and a DOM element to render into:
katex.render("c = \\pm\\sqrt{a^2 + b^2}", element);
To generate HTML on the server, you can use katex.renderToString
:
var html = katex.renderToString("c = \\pm\\sqrt{a^2 + b^2}");
// '<span class="katex">...</span>'
Make sure to include the CSS and font files, but there is no need to include the JavaScript.
See CONTRIBUTING.md
KaTeX is licenced under the MIT License.
[v0.1.0] - 2014-09-15
Initial Public Release
FAQs
Fast math typesetting for the web.
The npm package katex receives a total of 1,035,020 weekly downloads. As such, katex popularity was classified as popular.
We found that katex demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 7 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.