https://github.com/stalonelab/hexo-renderer-unified
Markdown renderer plugin for Hexo - based on Unified
https://github.com/stalonelab/hexo-renderer-unified
hexo markdown unified
Last synced: 5 months ago
JSON representation
Markdown renderer plugin for Hexo - based on Unified
- Host: GitHub
- URL: https://github.com/stalonelab/hexo-renderer-unified
- Owner: StaloneLab
- License: lgpl-3.0
- Created: 2019-05-25T11:53:49.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-05-01T05:25:13.000Z (about 3 years ago)
- Last Synced: 2024-12-01T05:33:48.042Z (over 1 year ago)
- Topics: hexo, markdown, unified
- Language: JavaScript
- Homepage:
- Size: 55.7 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# hexo-renderer-unified
[](https://www.npmjs.com/package/hexo-renderer-unified)
Markdown renderer plugin for Hexo - based on [unified](https://github.com/unifiedjs/unified)
## Installation
```bash
npm install hexo-renderer-unified --save
```
## Options
You can configure this plugin in `_config.yml`.
``` yaml
unified:
gfm: true
pedantic: false
commonmark: false
footnotes: true
math: false
code: false
code_ln: false
add_nbsp: false
titles_inc: 0
```
- **gfm** - Enable [GitHub flavored markdown](https://help.github.com/articles/github-flavored-markdown)
- **pedantic** - Conform to obscure parts of `markdown.pl` as much as possible.
- **commonmark** - Comply with the [CommonMark](https://spec.commonmark.org/current/) specification.
- **footnotes** - Enable footnotes at the end of the article
- **math** - Add TeX parsing and rendering using [KaTeX](https://katex.org/).
- **code** - Enable code highlighting. *Please disable code highlighting in Hexo if you want this package to highlight code.*
- **code_ln** - Add line numbering in front of highlighted code.
- **add_nbsp** - Replace spaces with non-breaking spaces where necessary.
- **titles_inc** - Shift all headers by a factor. Mainly intended for SEO.
## Extras
This plugins adds a simple syntax `<+++>` to separate abstract from content if you want to generate and RSS feed. If you don't need it, just don't use it.