carta/packages/plugin-math/README.md
BearToCode f0abf195b8 refactor: remove verbose prefixes
Remove "Carta" prefixes from various interface/components.

BREAKING CHANGE: Different objects have been renamed
2024-04-12 08:24:37 +02:00

70 lines
1.2 KiB
Markdown

# Carta Math Plugin
This plugin adds support for **Katex** expressions. Install it using:
```
npm i @cartamd/plugin-math
```
## Setup
### Styles
You need to get access to the katex **stylesheet**,
to do so, you can either install katex using:
```
npm i katex
```
and then adding this import to your app:
```ts
import 'katex/dist/katex.css';
```
or by using a content delivery network:
```html
<link
rel="stylesheet"
href="https://cdn.jsdelivr.net/npm/katex@0.16.7/dist/katex.min.css"
integrity="sha384-3UiQGuEI4TTMaFmGIZumfRPtfKQ3trwQE2JgosJxCnGmQpL/lJdjpcHkaaFwHlcI"
crossorigin="anonymous"
/>
```
### Extension
```svelte
<script lang="ts">
import { Carta, MarkdownEditor } from 'carta-md';
import { math } from '@cartamd/plugin-math';
const carta = new Carta({
extensions: [math()]
});
</script>
<MarkdownEditor {carta} />
```
## Usage
Inline:
```
Pythagorean theorem: $a^2+b^2=c^2$
```
Block:
```
$$
{\displaystyle {d^{2}x^{\mu } \over ds^{2}}+\Gamma ^{\mu }{}_{\alpha \beta }{dx^{\alpha } \over ds}{dx^{\beta } \over ds}=0}
$$
```
## Documentation
Checkout the [docs](https://beartocode.github.io/carta/plugins/math) for examples, options and more.