Markdown-it renderer plugin for Hexo.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.gitignore
LICENSE
README.md
index.js
package-lock.json
package.json

README.md

hexo-renderer-markdown

This renderer plugin is inspired by hexo-renderer-markdown-it. It uses Markdown-it as a render engine on Hexo with more markdown-it plugins.

Main Features

Installation

npm un hexo-renderer-marked --save
npm i hexo-renderer-markdown --save

Configuration

There is no need to config the renderer. If you really want to change some settings, you can add the config to the main hexo _config.yml file.

markdown:
    render:
        html: true
        xhtmlOut: false
        breaks: true
        linkify: true
        typographer: true
        quotes: “”‘’
    plugins:
        markdown-it-anchor:
            level: 1
            slugify: function (s) {return encodeURIComponent(s);} # String starting with 'function' will be parsed to a function that satisfies the plugin
            permalink: true
            permalinkClass: header-anchor
            permalinkSymbol: 
            permalinkBefore: true
        markdown-it-checkbox:
            divWrap: false
            divClass: checkbox
            idPrefix: checkbox
        markdown-it-katex:
            throwOnError: false
            errorColor: #cc0000
            csslink: https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.6.0/katex.min.css # KaTeX plugin needs the CSS file link

Add markdown-it Plugins

All the default plugins can't set to disabled because of the principle of this renderer. If you want to add a new markdown-it-something plugin, it's fairly simple.

  1. Install the plugin
npm i markdown-it-something --save
  1. Config the _config.yml
markdown:
    # ...
    plugins:
        markdown-it-something:
            option_example: value_example
            _parser: parser.use(require(pugs), pugs_opt) # This describes how to load the plugin because some plugins have nonstandard load style. The string will be 'eval' to execute. 'parser' - the markdown-it parser instance, 'pugs' - the plugin name, 'pugs_opt' - the plugin options.

Bug Reports

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