Files
site/themes/minimo/exampleSite/content/docs/katex-support.md
2021-09-06 13:02:12 -04:00

2.1 KiB

date, lastmod, title, authors, categories, tags, slug
date lastmod title authors categories tags slug
2018-08-12T12:30:00+06:00 2019-07-07T02:00:00+06:00 KaTeX Support
muniftanjim
features
config
katex
katex-support

KaTeX Syntax for Markdown

In your Markdown content, use the katex shortcode for inserting KaTeX. Check documentation for [Shortcode: katex]({{< relref "/docs/shortcodes.md#shortcode-katex" >}}).

Here's an example Markdown content:

When {{</* katex inline */>}} a \ne 0 {{</* /katex */>}}, there are two solutions to

{{</* katex */>}} ax^2 + bx + c = 0 {{</* /katex */>}}

and they are:

{{</* katex */>}}
x = {-b \pm \sqrt{b^2-4ac} \over 2a}
{{</* /katex */>}}

Output:

When {{< katex inline >}} a \ne 0 {{< /katex >}}, there are two solutions to

{{< katex >}} ax^2 + bx + c = 0 {{< /katex >}}

and they are:

{{< katex >}} x = {-b \pm \sqrt{b^2-4ac} \over 2a} {{< /katex >}}

Customize KaTeX Configuration

You can customize the default behavior of KaTeX if you want.

Minimo picks up configuration for KaTeX from the /data/config/katex.json file.

The default configuration options look like this:

{
  "library": {
    "js": {
      "main": "//unpkg.com/katex/dist/katex.min.js",
      "autoRender": "//unpkg.com/katex/dist/contrib/auto-render.min.js"
    },
    "css": {
      "main": "//unpkg.com/katex/dist/katex.min.css"
    }
  },
  "options": {}
}
  • library [Object]:
    • js [Object]:
    • css [Object]:
      • main [String]: URL for the main KaTeX stylesheet
  • options [Object]:

So, if you want to tinker with it's configuration options:

  • Create a /data/config/katex.json file in your site's repository
  • Copy the default configuration options
  • Start hacking