https://github.com/dimaslanjaka/hexo-renderers
All in one theme renderers and helpers for hexo
https://github.com/dimaslanjaka/hexo-renderers
ejs hexo hexo-helper hexo-renderer hexo-theme nunjucks pug
Last synced: 3 months ago
JSON representation
All in one theme renderers and helpers for hexo
- Host: GitHub
- URL: https://github.com/dimaslanjaka/hexo-renderers
- Owner: dimaslanjaka
- Created: 2023-03-27T10:51:28.000Z (about 2 years ago)
- Default Branch: pre-release
- Last Pushed: 2024-10-25T11:58:52.000Z (7 months ago)
- Last Synced: 2024-10-25T14:40:01.540Z (7 months ago)
- Topics: ejs, hexo, hexo-helper, hexo-renderer, hexo-theme, nunjucks, pug
- Language: TypeScript
- Homepage: https://www.webmanajemen.com/docs/hexo-renderers
- Size: 17 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: docs/readme.md
Awesome Lists containing this project
README
# 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](https://github.com/dimaslanjaka/site/tree/hexo-renderers/views)
- auto fix post assets folder
- renderer cache strategy
## Requirements
Custom `markdown-it` from [https://github.com/dimaslanjaka/markdown-it](https://github.com/dimaslanjaka/markdown-it/tree/master/release)
> This only required when you add `markdown-it` on `_config_yml.renderers.engine`
yarn add markdown-it@{{ markdown_it_tarball }}
> 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`
```yaml
renderers:
engines: ['ejs', 'stylus', 'nunjucks', 'dartsass', 'pug', 'sass', 'markdown-it', 'rollup', 'marked']
generator:
# enable generate /meta.json
- meta
# enable generate related posts
- related-posts
fix:
# Fix html
# - fix invalid post asset folder path
# - escape invalid html tags into html entities
html: false
# Toggle cache
cache: false
# when _config_yml.renderers.fix.html is true
# this plugin transforming unknown tags into html entities
# add custom html tag names to avoid from transformation
# reference src\markdown-it\renderer.ts
# reference src\markdown-it\html-tags.js
html_tags: ['customtag', 'custom-html-tag']
```
## Configurations
### Markdown
#### markdown-it
Configuration for `markdown-it` engine
```yaml
markdown:
preset: default
# Toggle render nunjucks in markdown
disableNunjucks: true
render:
html: true
xhtmlOut: false
# prefix class of
langPrefix: language-
breaks: true
# auto convert url plaintext into anchor
linkify: false
typographer: true
quotes: “”‘’
# Toggle cache
cache: true
enable_rules: null
disable_rules: null
plugins:
- markdown-it-abbr
- markdown-it-attrs
- markdown-it-bracketed-spans
- markdown-it-sup
- markdown-it-cjk-breaks
- markdown-it-sub
- markdown-it-deflist
- markdown-it-footnote
- markdown-it-ins
- markdown-it-mark
- name: "@renbaoshuo/markdown-it-katex"
options:
skipDelimitersCheck: true
- name: markdown-it-emoji
options:
shortcuts:
laughing: :D
smile: [":)", ":-)"]
# - name: markdown-it-table-of-contents
# options:
# includeLevel:
# - 1
# - 2
# - 3
# - 4
# - 5
# - 6
anchors:
level: 2
collisionSuffix: ""
permalink: false
permalinkClass: header-anchor
permalinkSide: left
permalinkSymbol: ¶
case: 0
separator: "-"
images:
lazyload: false
prepend_root: false
post_asset: true
inline: false # https://markdown-it.github.io/markdown-it/#MarkdownIt.renderInline
```
#### marked
This marked renderer is improved from [hexo-renderer-marked](https://github.com/hexojs/hexo-renderer-marked/tree/master#options).
Configuration for `marked` engine [same as hexo-renderer-marked - read here](https://github.com/hexojs/hexo-renderer-marked/tree/master#options)
> **NOTE**: this plugin add `cache` options
```yaml
marked:
cache: true # default false
# rest of marked options
```
### SASS
> - `dartsass` improved from [hexo-renderer-dartsass](https://github.com/KentarouTakeda/hexo-renderer-dartsass/blob/master/README.md)
> - `sass` improved from [hexo-renderer-sass](https://github.com/knksmith57/hexo-renderer-sass#_configyml)
set config for your desired renderer engine.
- [hexo-renderer-dartsass](https://github.com/KentarouTakeda/hexo-renderer-dartsass/blob/master/README.md)
- [hexo-renderer-sass](https://github.com/knksmith57/hexo-renderer-sass#_configyml)
## Changelog
{% include "changelog.md" %}