Skip to content

byronwanbl/hexo-renderer-markdown-it-katex

 
 

Repository files navigation

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.

About

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

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%