hexo-renderers

All in one theme renderers and helpers for hexo. Load all hexo renderer engines at once.

Features

• use any type layout inside source
• more custom helpers
• related post helpers examples
• auto fix post assets folder
• renderer cache strategy

Requirements

Custom markdown-it from https://github.com/dimaslanjaka/markdown-it

This only required when you add markdown-it on _config_yml.renderers.engine

yarn add markdown-it@https://github.com/dimaslanjaka/markdown-it/raw/17ccc825cbb3e4c6d59edada5f6d93f27075d752/release/markdown-it.tgz

Change hash with latest commit hash

Why must change?

Original markdown-it now only support for ESM, we need shim markdown-it into CommonJS

Specify renderers

You can specify some renderers by _config.yml

1renderers:
2  engines: ['ejs', 'stylus', 'nunjucks', 'dartsass', 'pug', 'sass', 'markdown-it', 'rollup', 'marked']
3  generator:
4    # enable generate <domain>/meta.json
5    - meta
6    # enable generate related posts
7    - related-posts
8  fix:
9    # Fix html
10    # - fix invalid post asset folder path
11    # - escape invalid html tags into html entities
12    html: false
13    # Toggle cache
14    cache: false
15  # when _config_yml.renderers.fix.html is true
16  # this plugin transforming unknown tags into html entities
17  # add custom html tag names to avoid from transformation
18  # reference src\markdown-it\renderer.ts
19  # reference src\markdown-it\html-tags.js
20  html_tags: ['customtag', 'custom-html-tag']

Configurations

Markdown

markdown-it

Configuration for markdown-it engine

1markdown:
2  preset: default
3  # Toggle render nunjucks in markdown
4  disableNunjucks: true
5  render:
6    html: true
7    xhtmlOut: false
8    # prefix class of <pre><code class="language-">
9    langPrefix: language-
10    breaks: true
11    # auto convert url plaintext into anchor
12    linkify: false
13    typographer: true
14    quotes: “”‘’
15    # Toggle cache
16    cache: true
17  enable_rules: null
18  disable_rules: null
19  plugins:
20    - markdown-it-abbr
21    - markdown-it-attrs
22    - markdown-it-bracketed-spans
23    - markdown-it-sup
24    - markdown-it-cjk-breaks
25    - markdown-it-sub
26    - markdown-it-deflist
27    - markdown-it-footnote
28    - markdown-it-ins
29    - markdown-it-mark
30    - name: "@renbaoshuo/markdown-it-katex"
31      options:
32        skipDelimitersCheck: true
33    - name: markdown-it-emoji
34      options:
35        shortcuts:
36          laughing: :D
37          smile: [":)", ":-)"]
38    # - name: markdown-it-table-of-contents
39    #   options:
40    #     includeLevel:
41    #       - 1
42    #       - 2
43    #       - 3
44    #       - 4
45    #       - 5
46    #       - 6
47  anchors:
48    level: 2
49    collisionSuffix: ""
50    permalink: false
51    permalinkClass: header-anchor
52    permalinkSide: left
53    permalinkSymbol: ¶
54    case: 0
55    separator: "-"
56  images:
57    lazyload: false
58    prepend_root: false
59    post_asset: true
60  inline: false  # https://markdown-it.github.io/markdown-it/#MarkdownIt.renderInline

marked

This marked renderer is improved from hexo-renderer-marked.

Configuration for marked engine same as hexo-renderer-marked - read here

NOTE: this plugin add cache options

1marked:
2  cache: true # default false
3  # rest of marked options

SASS

• dartsass improved from hexo-renderer-dartsass
• sass improved from hexo-renderer-sass

set config for your desired renderer engine.

• hexo-renderer-dartsass
• hexo-renderer-sass

Changelog

3.0.1

• Drop activating all engines by default. All engine follows _config_yml.renderers.engine
• Separate html fixer
• Fix post asset folder fixer

3.0.0

• migrate to ESM with shim for CommonJS

2.0.6

• fix: escape invalid html tag curly brackets on hyperlink text to html entities
• feat: auto fix post assets folder

2.0.5

• chore: disable rollup renderer by default

2.0.4

• feat: support for hexo 7.3.0
• update dependencies (except markdown-it)

2.0.1

• fix maximum call stack exceeded

2.0.0

• change options structure
• add meta.json generator which available at http://example.com/meta.json
• add related post helper

1.0.13

• fix: invalid default markdown options

1.0.12

• fix: cannot find installed markdown-it plugins

1.0.5

• improved dartsass
• add and improved hexo-renderer-sass
• optimize docs

1.0.6

• add more helpers

1.0.7

• hotfix known issues

1.0.8

• add hexo-renderer-markdown-it
• hotfix nunjucks renderer
• update dependencies