math-term
v1.0.2
Published
Math term is your web component that helps you to write mathematical equations in the browser.
Maintainers
metalbolicxReadme
Math Term
Write mathematical expressions in your web page.
Suported Versions:
A custom element to render mathematical expressions in a web page using KaTeX. Write in LaTeX and enjoy!
📦 Installation
Using npm
To install the component, run the following command in your project directory:
npm i math-termIf your are creating a project with a bundler like Webpack, Rollup, or Parcel, you can import the component in your JavaScript/TypeScript file:
import "math-term";Using a CDN
You can also use a CDN to include the component in your project. Add the following script tag to your HTML file:
<script type="module" src="https://cdn.jsdelivr.net/npm/math-term/dist/math-term.js" lang="javascript"></script>or
<script type="module" src="https://unpkg.com/math-term/dist/math-term.js" lang="javascript"></script>🚀 Usage
In the body of the HTML file, add the math-term component and provide the mathematical expression. For example:
<math-term>f(x) = \frac{1}{x}</math-term>🚧 Caution: When the LaTeX syntax is incorrect, the expression will be rendered as plain text in red. Make sure to write valid LaTeX expressions.
Full Example
<!DOCTYPE html>
<html>
<head>
<title>Math component</title>
<script type="module" src="https://cdn.jsdelivr.net/npm/math-term/dist/math-term.js"></script>
</head>
<body>
<math-term>f(x) = \frac{1}{x}</math-term>
</body>
</html>⚙️ Attributes
|Attribute|Type|Description|
|---|---|---|
|displayBlockMode|boolean|If true, renders the math expression in block mode instead of inline mode.|
💡 Do you want to learn more?
- Get use to write LaTeX expressions with Overleaf.
Contributing
Contributions are welcome! If you have suggestions for improvements or find bugs, please open an issue or submit a pull request.
Technologies Used
License
Released under the MIT License by @MetalbolicX