https://github.com/breuleux/quaint-katex

Inline math for Quaint using KaTeX
https://github.com/breuleux/quaint-katex

inline-math katex quaint

Last synced: 9 days ago
JSON representation

Inline math for Quaint using KaTeX

• Host: GitHub
• URL: https://github.com/breuleux/quaint-katex
• Owner: breuleux
• Created: 2016-09-12T16:09:47.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2017-02-02T05:34:10.000Z (almost 8 years ago)
• Last Synced: 2024-10-18T18:54:33.645Z (28 days ago)
• Topics: inline-math, katex, quaint
• Language: JavaScript
• Size: 5.86 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

# quaint-katex

Katex support for Quaint

## Install

In your Quaint project directory, run the command:

    quaint --setup katex

## Usage

The plugin defines two operators:

* `$+[...]` inserts math inline

* `$$ ...` displays one or more equations

For example:

```

Inline math! $+[x_1 + x_2]

Display math!

$$ \sum_{i=1}^{1000} x_i + y_i^2 + z_i^3

```

Instead of LaTeX's awkward line break syntax, you can use bullet

points in the environment created by `$$` to list multiple equations,

for example:

```

$$

  * x & = y + z

  * x - y & = z

```

### Wrap with a class

Instead of an environment, or in addition to it, you may specify class

descriptions and an id for an equations block:

```

.my-class#some-id $$

  * x & = y + z

  * x - y & = z

```

The above will wrap the equation with `
...
`,

which means you can easily customize the display of various equations.


## Options

There are no options at the moment.