SilverBullet KaTeX plug

This plug lets you render LaTeX using code blocks in your SilverBullet markdown files. To achieve this it uses KaTeX, a small subset of LaTeX written in JavaScript.

Installation

Run the {[Plugs: Add]} command and paste in: github:silverbulletmd/silverbullet-katex/katex.plug.js

That's all!

Use

Put a latex block in your markdown:

```latex
c = \pm\sqrt{a^2 + b^2}
```

And move your cursor outside of the block to live preview it!

Note: KaTeX itself is only partially bundled with this plug, the JS is included, but CSS and fonts are fetched from the JSDelivr CDN. This means this plug will not work without an Internet connection. The reason for this limitation is that it is not yet possible to distribute font files via plugs, and KaTeX depends on specific web fonts.

Settings

The plug offers multiple settings to control the behaviour of KaTeX. Just put the following in you SETTINGS file and customize:

katex:
  # To change the default rendering mode to displaystyle, alternatively use `\displaystyle` in the block
  displayMode: true
  # To enable some special features KaTeX offers to e.g. allow DOM manipulation
  allowedFeatures: all
  # Alternatively specifiy a list of features. For reference: https://katex.org/docs/options
  allowedFeatures:
    - mathVsTextUnits
    - commentAtEnd
  # Macros can be globally specified likes this. Make sure to escape the backslash
  macros:
    - macro: "\\coolR"
      expansion: "\\mathbb{R}"

Build

Assuming you have Deno and SilverBullet installed, simply build using:

deno task build

Or to watch for changes and rebuild automatically

deno task watch

Then, load the locally built plug, add it to your PLUGS note with an absolute path, for instance:

- file:/Users/you/path/to/katex.plug.json

And run the Plugs: Update command in SilverBullet.