hexo-renderer-markdown-it-katex

Supporting KaTeX out of box. No need to include the stylesheet manually.

Usage no npm install needed!

<script type="module">
  import hexoRendererMarkdownItKatex from 'https://cdn.skypack.dev/hexo-renderer-markdown-it-katex';
</script>

README

hexo-renderer-markdown-it-katex

This plugin is forked from hexo-renderer-markdown-it. Adds support for KaTeX out of box, which means you don't need to include the KaTeX stylesheet in your HTML manually.

This renderer plugin uses Markdown-it as a render engine on Hexo. Adds support for Markdown and CommonMark.

Main Features

  • Support for Markdown, GFM and CommonMark
  • Extensive configuration
  • Faster than the default renderer | hexo-renderer-marked
  • Safe ID for headings
  • Anchors for headings with ID
  • Footnotes
  • <sub> H2O
  • <sup> x2
  • <ins> Inserted
  • KaTeX out of box

Installation

yarn remove hexo-renderer-marked
yarn add hexo-renderer-markdown-it-katex

Options

markdown:
  render:
    html: true
    xhtmlOut: false
    breaks: true
    linkify: true
    typographer: true
    quotes: '“”‘’'
  plugins:
  anchors:
    level: 2
    collisionSuffix: ''

Refer to the wiki for more details.

KaTeX

We use @abreto/markdown-it-katex plugin and automatically include the KaTeX stylesheet in every HTML document generated. Current KaTeX version is 0.11.1.

Suggested plugins

  • markdown-it-deflist
  • markdown-it-abbr

Requests and bug reports

If you have any feature requests or bugs to report, you're welcome to file an issue.