Gathering detailed insights and metrics for katex
Gathering detailed insights and metrics for katex
Installations
npm install katexDeveloper
Developer Guide
BETA
Module System
CommonJS, ESM
Min. Node Version
Typescript Support
No
Node Version
20.15.0
NPM Version
10.7.0
Statistics
18,459 Stars
2,157 Commits
1,183 Forks
282 Watching
31 Branches
152 Contributors
Updated on 28 Nov 2024
Languages
JavaScript (85.76%)
Perl (7.74%)
HTML (2.31%)
Python (1.24%)
SCSS (1.23%)
CSS (0.82%)
Shell (0.37%)
Makefile (0.31%)
Dockerfile (0.13%)
TeX (0.09%)
Total Downloads
Cumulative downloads
Total Downloads
133,913,175
Last day
-2.9%
276,543
Compared to previous day
Last week
0.7%
1,454,593
Compared to previous week
Last month
19.1%
6,100,626
Compared to previous month
Last year
72%
53,734,357
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
Dev Dependencies
74
@babel/core@babel/eslint-parser@babel/plugin-proposal-class-properties@babel/plugin-syntax-flow@babel/plugin-transform-react-jsx@babel/plugin-transform-runtime@babel/preset-env@babel/preset-flow@babel/preset-react@babel/register@babel/runtime@rollup/plugin-alias@rollup/plugin-babel@semantic-release/changelog@semantic-release/gitbabel-jestbabel-loaderbabel-plugin-istanbulbabel-plugin-prevalbabel-plugin-version-inlinebenchmarkbrowserslistbrowserstack-localcaniuse-litecss-loadercssnanoeslinteslint-import-resolver-webpackeslint-plugin-actionseslint-plugin-flowtypeeslint-plugin-importeslint-plugin-reactflow-binfs-extragothuskyistanbul-lib-coverageistanbul-lib-reportistanbul-reportsjestjest-diffjest-environment-jsdomjest-matcher-utilsjest-message-utiljest-serializer-htmljs-yamljson-stable-stringifyjspngoptmini-css-extract-pluginmkdirpp-retrypakopostcsspostcss-loaderpostcss-preset-envpostcss-scssprettierquery-stringrimrafrollupsasssass-loaderselenium-webdriversemantic-releasesri-toolboxstyle-loaderstylelintstylelint-config-standardstylelint-scssterser-webpack-pluginwebpackwebpack-bundle-analyzerwebpack-cliwebpack-dev-server
Versions
KaTeX is a fast, easy-to-use JavaScript library for TeX math rendering on the web.
- Fast: KaTeX renders its math synchronously and doesn't need to reflow the page. See how it compares to a competitor in this speed test.
- Print quality: KaTeX's layout is based on Donald Knuth's TeX, the gold standard for math typesetting.
- Self contained: KaTeX has no dependencies and can easily be bundled with your website resources.
- Server side rendering: KaTeX produces the same output regardless of browser or environment, so you can pre-render expressions using Node.js and send them as plain HTML.
KaTeX is compatible with all major browsers, including Chrome, Safari, Firefox, Opera, Edge, and IE 11.
KaTeX supports much (but not all) of LaTeX and many LaTeX packages. See the list of supported functions.
Try out KaTeX on the demo page!
Getting started
Starter template
1<!DOCTYPE html> 2<!-- KaTeX requires the use of the HTML5 doctype. Without it, KaTeX may not render properly --> 3<html> 4 <head> 5 <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.16.11/dist/katex.min.css" integrity="sha384-nB0miv6/jRmo5UMMR1wu3Gz6NLsoTkbqJghGIsx//Rlm+ZU03BU6SQNC66uf4l5+" crossorigin="anonymous"> 6 7 <!-- The loading of KaTeX is deferred to speed up page rendering --> 8 <script defer src="https://cdn.jsdelivr.net/npm/katex@0.16.11/dist/katex.min.js" integrity="sha384-7zkQWkzuo3B5mTepMUcHkMB5jZaolc2xDwL6VFqjFALcbeS9Ggm/Yr2r3Dy4lfFg" crossorigin="anonymous"></script> 9 10 <!-- To automatically render math in text elements, include the auto-render extension: --> 11 <script defer src="https://cdn.jsdelivr.net/npm/katex@0.16.11/dist/contrib/auto-render.min.js" integrity="sha384-43gviWU0YVjaDtb/GhzOouOXtZMP/7XUzwPTstBeZFe/+rCMvRwr4yROQP43s0Xk" crossorigin="anonymous" 12 onload="renderMathInElement(document.body);"></script> 13 </head> 14 ... 15</html>
You can also download KaTeX and host it yourself.
For details on how to configure auto-render extension, refer to the documentation.
API
Call katex.render to render a TeX expression directly into a DOM element.
For example:
1katex.render("c = \\pm\\sqrt{a^2 + b^2}", element, { 2 throwOnError: false 3});
Call katex.renderToString to generate an HTML string of the rendered math,
e.g., for server-side rendering. For example:
1var html = katex.renderToString("c = \\pm\\sqrt{a^2 + b^2}", { 2 throwOnError: false 3}); 4// '<span class="katex">...</span>'
Make sure to include the CSS and font files in both cases. If you are doing all rendering on the server, there is no need to include the JavaScript on the client.
The examples above use the throwOnError: false option, which renders invalid
inputs as the TeX source code in red (by default), with the error message as
hover text. For other available options, see the
API documentation,
options documentation, and
handling errors documentation.
Demo and Documentation
Learn more about using KaTeX on the website!
Contributors
Code Contributors
This project exists thanks to all the people who contribute code. If you'd like to help, see our guide to contributing code.
Financial Contributors
Become a financial contributor and help us sustain our community.
Individuals
Organizations
Support this project with your organization. Your logo will show up here with a link to your website.
License
KaTeX is licensed under the MIT License.
Stable Version
The latest stable version of the package.
Stable Version
0.16.11
MODERATE
4
MODERATE
5.5/10
Summary
KaTeX missing normalization of the protocol in URLs allows bypassing forbidden protocols
Affected Versions
>= 0.11.0, < 0.16.10
Patched Versions
0.16.10
MODERATE
6.3/10
Summary
KaTeX's `\includegraphics` does not escape filename
Affected Versions
>= 0.11.0, < 0.16.10
Patched Versions
0.16.10
MODERATE
6.5/10
Summary
KaTeX's maxExpand bypassed by Unicode sub/superscripts
Affected Versions
>= 0.15.4, < 0.16.10
Patched Versions
0.16.10
MODERATE
6.5/10
Summary
KaTeX's maxExpand bypassed by `\edef`
Affected Versions
>= 0.10.0-beta, < 0.16.10
Patched Versions
0.16.10
Reason
security policy file detected
Details
- Info: security policy file detected: docs/security.md:1
- Info: Found linked content: docs/security.md:1
- Info: Found disclosure, vulnerability, and/or timelines in security policy: docs/security.md:1
- Info: Found text in security policy: docs/security.md:1
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
SAST tool is run on all commits
Details
- Info: SAST configuration detected: CodeQL
- Info: all commits (22) are checked with a SAST tool
Reason
3 commit(s) and 7 issue activity found in the last 90 days -- score normalized to 8
Reason
Found 11/23 approved changesets -- score normalized to 4
Reason
dangerous workflow patterns detected
Details
- Warn: untrusted code checkout '${{ format('refs/pull/{0}/merge', github.event.pull_request.number) }}': .github/workflows/fonts.yml:19
- Warn: untrusted code checkout '${{ format('refs/pull/{0}/merge', github.event.pull_request.number) }}': .github/workflows/fonts.yml:92
- Warn: untrusted code checkout '${{ github.event_name == 'pull_request_target' && format('refs/pull/{0}/merge', github.event.pull_request.number) || '' }}': .github/workflows/screenshotter.yml:38
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/fonts.yml:15
- Warn: no topLevel permission defined: .github/workflows/ci.yml:1
- Info: topLevel 'actions' permission set to 'read': .github/workflows/codeql-analysis.yml:12
- Info: topLevel 'contents' permission set to 'read': .github/workflows/codeql-analysis.yml:13
- Warn: topLevel 'security-events' permission set to 'write': .github/workflows/codeql-analysis.yml:14
- Warn: no topLevel permission defined: .github/workflows/fonts.yml:1
- Warn: no topLevel permission defined: .github/workflows/screenshotter.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
Project has not signed or included provenance with any releases.
Details
- Warn: release artifact v0.16.11 not signed: https://api.github.com/repos/KaTeX/KaTeX/releases/163608577
- Warn: release artifact v0.16.10 not signed: https://api.github.com/repos/KaTeX/KaTeX/releases/148120953
- Warn: release artifact v0.16.9 not signed: https://api.github.com/repos/KaTeX/KaTeX/releases/123388521
- Warn: release artifact v0.16.8 not signed: https://api.github.com/repos/KaTeX/KaTeX/releases/109769805
- Warn: release artifact v0.16.7 not signed: https://api.github.com/repos/KaTeX/KaTeX/releases/101266446
- Warn: release artifact v0.16.11 does not have provenance: https://api.github.com/repos/KaTeX/KaTeX/releases/163608577
- Warn: release artifact v0.16.10 does not have provenance: https://api.github.com/repos/KaTeX/KaTeX/releases/148120953
- Warn: release artifact v0.16.9 does not have provenance: https://api.github.com/repos/KaTeX/KaTeX/releases/123388521
- Warn: release artifact v0.16.8 does not have provenance: https://api.github.com/repos/KaTeX/KaTeX/releases/109769805
- Warn: release artifact v0.16.7 does not have provenance: https://api.github.com/repos/KaTeX/KaTeX/releases/101266446
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Info: Possibly incomplete results: error parsing shell code: a command can only contain words and redirects; encountered (: .github/workflows/screenshotter.yml:58
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/KaTeX/KaTeX/ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/KaTeX/KaTeX/ci.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/KaTeX/KaTeX/ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:58: update your workflow using https://app.stepsecurity.io/secureworkflow/KaTeX/KaTeX/ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:67: update your workflow using https://app.stepsecurity.io/secureworkflow/KaTeX/KaTeX/ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/KaTeX/KaTeX/codeql-analysis.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/KaTeX/KaTeX/codeql-analysis.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/KaTeX/KaTeX/codeql-analysis.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/fonts.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/KaTeX/KaTeX/fonts.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/fonts.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/KaTeX/KaTeX/fonts.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/fonts.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/KaTeX/KaTeX/fonts.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/fonts.yml:66: update your workflow using https://app.stepsecurity.io/secureworkflow/KaTeX/KaTeX/fonts.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/fonts.yml:75: update your workflow using https://app.stepsecurity.io/secureworkflow/KaTeX/KaTeX/fonts.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/fonts.yml:92: update your workflow using https://app.stepsecurity.io/secureworkflow/KaTeX/KaTeX/fonts.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/fonts.yml:113: update your workflow using https://app.stepsecurity.io/secureworkflow/KaTeX/KaTeX/fonts.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/fonts.yml:118: update your workflow using https://app.stepsecurity.io/secureworkflow/KaTeX/KaTeX/fonts.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/screenshotter.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/KaTeX/KaTeX/screenshotter.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/screenshotter.yml:47: update your workflow using https://app.stepsecurity.io/secureworkflow/KaTeX/KaTeX/screenshotter.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/screenshotter.yml:84: update your workflow using https://app.stepsecurity.io/secureworkflow/KaTeX/KaTeX/screenshotter.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/screenshotter.yml:89: update your workflow using https://app.stepsecurity.io/secureworkflow/KaTeX/KaTeX/screenshotter.yml/main?enable=pin
- Warn: containerImage not pinned by hash: dockers/fonts/Dockerfile:1: pin your Docker image by updating ubuntu:20.04 to ubuntu:20.04@sha256:8e5c4f0285ecbb4ead070431d29b576a530d3166df73ec44affc1cd27555141b
- Warn: containerImage not pinned by hash: dockers/texcmp/Dockerfile:1: pin your Docker image by updating ubuntu:17.10 to ubuntu:17.10@sha256:3b811ac794645dfaa47408f4333ac6e433858ff16908965c68f63d5d315acf94
- Warn: pipCommand not pinned by hash: dockers/fonts/Dockerfile:4-21
- Warn: npmCommand not pinned by hash: dockers/texcmp/Dockerfile:33-35
- Warn: npmCommand not pinned by hash: dockers/texcmp/Dockerfile:33-35
- Info: 0 out of 17 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 3 third-party GitHubAction dependencies pinned
- Info: 0 out of 2 containerImage dependencies pinned
- Info: 0 out of 1 pipCommand dependencies pinned
- Info: 0 out of 2 npmCommand dependencies pinned
Reason
66 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
- Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
- Warn: Project is vulnerable to: GHSA-257v-vj4p-3w2h
- Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-q8pj-2vqx-8ggc
- Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
- Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
- Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
- Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
- Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
- Warn: Project is vulnerable to: GHSA-7wwv-vh3v-89cq
- Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
- Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
- Warn: Project is vulnerable to: GHSA-33f9-j839-rf8h
- Warn: Project is vulnerable to: GHSA-c36v-fmgq-m8hx
- Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
- Warn: Project is vulnerable to: GHSA-7r28-3m3f-r2pr
- Warn: Project is vulnerable to: GHSA-r8j5-h5cx-65gg
- Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
- Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
- Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
- Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
- Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
- Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
- Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
- Warn: Project is vulnerable to: GHSA-566m-qj78-rww5
- Warn: Project is vulnerable to: GHSA-hwj9-h5mp-3pm3
- Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
- Warn: Project is vulnerable to: GHSA-gj77-59wh-66hg
- Warn: Project is vulnerable to: GHSA-hqhp-5p83-hx96
- Warn: Project is vulnerable to: GHSA-3949-f494-cm99
- Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-44c6-4v22-4mhx
- Warn: Project is vulnerable to: GHSA-4x5v-gmq8-25ch
- Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
- Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
- Warn: Project is vulnerable to: GHSA-jv35-xqg7-f92r
- Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7
- Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
- Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
- Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
- Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
- Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
- Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
- Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
- Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Score
3.6
/10
Last Scanned on 2024-11-25
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More