ksky521 / hexo-renderer-markdown-it

Markdown-it is a Markdown parser, done right. A faster and CommonMark compliant alternative for Hexo.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

hexo-renderer-markdown-it

Build Status npm version npm dependencies Coverage Status

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

Installation

Follow the installation guide.

Options

markdown:
  render:
    html: true
    xhtmlOut: false
    breaks: true
    linkify: true
    typographer: true
    quotes: '“”‘’'
  plugins:
  anchors:
    level: 2
    collisionSuffix: ''
    permalink: false,
    permalinkClass: 'header-anchor'
    permalinkSymbol: ''
    case: 0
    separator: ''

Refer to the wiki for more details.

Requests and bug reports

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

About

Markdown-it is a Markdown parser, done right. A faster and CommonMark compliant alternative for Hexo.

License:MIT License


Languages

Language:JavaScript 100.0%