deining / markdown-katex-ad

Adds KaTeX support for Python Markdown

markdown-katex

This is an extension for Python Markdown which adds KaTeX support.

```math
f(x) = \int_{-\infty}^\infty
    \hat f(\xi)\,e^{2 \pi i \xi x}
    \,d\xi
```

Project/Repo:

Code Quality/CI:

Name	role	since	until
Manuel Barkhau ([email protected])	author/maintainer	2019-05	-

Install

$ pip install markdown-katex
...
$ python -m markdown_katex --version
markdown-katex version:  v202105.1031 (using binary: /usr/local/bin/npx --no-install katex)
0.13.0

This package includes the following binaries:

• katex-v0.13.0-x86_64-Linux
• katex-v0.13.0-x86_64-Macos
• katex-v0.13.0-x86_64-Windows

If you are on a different platform, or want to use a more recent version of katex-cli, you will need to install it via npm.

$ npx katex
$ npx katex --version
0.13.0

This extension will always use the locally installed version of KaTeX if it is available, instead of using the implementation bundled with this package.

No JavaScript is required to render the resulting HTML, so it can be used with more limited renderers (which don't support JavaScript) such as WeasyPrint .

Usage

Formulas can be created and edited interactively using the editor on katex.org. They also have some good documentation for the subset of LaTeX that is supported. When embedding these in your Markdown files, they must be marked with a special syntax in order to be rendered using KaTeX. There are many syntax extensions for Markdown that allow LaTeX formulas to be embedded, however this package only supports the syntax introduced by Gitlab:

• For inline mode formulas: $`...`$
• For display mode formulas: ```math

Here is an example that uses this syntax.

There are two main advantages of this syntax:

1. Gitlab has an existing Markdown renderer that can be used without the need to download any software. This implementation also uses KaTeX, so the output should be exactly the same as this extension.
2. The fallback behaviour of other Markdown renderers is to render the raw LaTeX as inline code or a code block. This means that they won't inadvertently parse a LaTeX formula as Markdown syntax.

Hopefully other renderers will also adopt support for this syntax as:

1. Rendering is done in the browser using KaTeX so implementation effort and should be minimal.
2. The false positive rate for existing Markdown documents is negligible (ie. existing alternate use of $` syntax is minimal to non-existent).

Options

• no_inline_svg: Replace inline <svg> with <img data:image/svg+xml;base64.."> tags.
• insert_fonts_css: Insert font loading stylesheet (default: True).

Development/Testing

$ git clone https://gitlab.com/mbarkhau/markdown-katex
$ cd markdown-katex
$ make conda
$ make lint mypy test

MkDocs Integration

In your mkdocs.yml add this to markdown_extensions.

# mkdocs.yml
markdown_extensions:
  - markdown_katex:
      no_inline_svg: True
      insert_fonts_css: True
      macro-file: macros.tex

The macro-file might looks something like this:

% macros.tex
\mymacro:\text{prefix #1 suffix}

WeasyPrint Integration

When you generate html that is to be consumed by WeasyPrint, you need to use the no_inline_svg=True option. This is due to a long standing limitation of WeasyPrint. Without this option, some KaTeX formulas will not render properly, e.g. \sqrt

md_ctx = markdown.Markdown(
    extensions=[
        'markdown.extensions.toc',
        'markdown.extensions.extra',
        'markdown.extensions.abbr',
        ...
        'markdown_katex',
    ],
    extension_configs={
        'markdown_katex': {
            'no_inline_svg': True,      # fix for WeasyPrint
            'insert_fonts_css': True,
        },
    }
)
raw_html_text = md_ctx.convert(md_text)

You can also use markdown-katex for the conversion of individual formulas from tex to html:

from markdown_katex.extension import tex2html

tex_text = r"""
\frac{1}{\left(\sqrt{\phi\sqrt{5}}-\phi\right)e^{\frac{2}{5}\pi}}=
 1+\frac{e^{-2\pi}} {
   1+\frac{e^{-4\pi}} {
     1+\frac{e^{-6\pi}} {
       1+\frac{e^{-8\pi}} {
         1+\cdots
       }
     }
   }
}
"""
options = {'no_inline_svg': True, 'insert_fonts_css': False}
html = tex2html(tex_text, options)