snowyu / hexo-renderer-markdown-it Goto Github PK

View Code? Open in Web Editor NEW

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

License: MIT License

JavaScript 100.00%

hexo-renderer-markdown-it's Introduction

hexo-renderer-markdown-it

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
- Multi-languages Supported
Footnotes
<sub> H₂O
<sup> x²
<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: ''
    # replacement String to replace whitespace with, defaults to `-` (provides API compatibility with the `slug` module)
    replacement:  '-'
    # separator String, equivalent to `replacement` (provides API compatibility with the `speakingurl` module)
    # separator:  '-'
    # lang String, ISO 639-1 two-letter language code, defaults to auto-detected language
    #lang: 'de'
    # tone Boolean, add tone numbers to Pinyin transliteration of Chinese, defaults to `true`
    tone: true
    # separateNumbers Boolean, separate numbers that are within a word, defaults to `false`
    separateNumbers: false
    # maintainCase Boolean, maintain the original string's casing, defaults to `false`
    maintainCase: false
    #custom
    #  - Object, custom map for translation, overwrites all i.e. `{ '&': '#', '*': ' star ' }`
    #  - Array, add chars to allowed charMap
    #custom: