As a frontend project, hexojs/hexo-renderer-markdown-it has picked up 368 stars on GitHub (JavaScript). Markdown-it is a Markdown parser, done right. A faster and CommonMark compliant alternative for Hexo.
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
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
Footnotes
<sub> H2O
<sup> x2
<ins> Inserted
Installation
Warning: make sure you're inside the main hexo directory before starting this guide.
A default Hexo installation will include a markdown renderer plugin which uses marked, so you will have to remove it if you want to use hexo-renderer-markdown-it.
$ npm un hexo-renderer-marked --save
If you have already removed the default renderer, and others you might of added, you can now safely install hexo-renderer-markdown-it
"commonmark" - configures parser to strict CommonMark mode.
"default" - similar to GFM, used when no preset name given. Enables all available rules, but still without html, typographer & autolinker.
"zero" - all rules disabled. Useful to quickly setup your config via .enable(). For example, when you need only bold and italic markup and nothing else.
Note that the default render and anchor options override some options in the preset. If you prefer to have the preset only:
markdown:
preset: 'default'
render:
anchors:
Render options
html
The html setting defines whether or not HTML content inside the document should be escaped or passed to the final result.
html: true # Doesn't escape HTML content
## OR
html: false # Escapes HTML content so the tags will appear as text.
xhtmlOut
The xhtmlOut setting defines whether the parser will export fully XHTML compatible tags. This only needs to be true for complete CommonMark support.
xhtmlOut: true # Parser produces fully XHTML compliant code.
# Ex: A line breaks will be <br />
## OR
xhtmlOut: false # Parser will not produce XHTML compliant code.
# Ex: A line break will be <br>
breaks
Makes line breaks in the source file will be parsed into <br> tags. So every time you press the Enter key you will create a line break, which is not the default Markdown, CommonMark, or GFM behaviour.
breaks: true # Parser produces `<br>` tags every time there is a line break in the source document.
## OR
breaks: false # Parser will ignore line breaks in the source document.
#Default double line break creates paragraph is still supported
langPrefix
Add a prefix to the class name of code blocks (when a language is specified).
langPrefix: 'language-' # default
This option only applies when both Hexo's built-in highlighters are disabled.
Example:
langPrefix: 'lang-'
Source:
``` js
example
```
HTML:
<pre>
<code class="lang-js">example</code>
</pre>
linkify
The parser has the ability to inline links pasted directly into the text. If you write a piece of text that looks like a link it will be rendered as <a src="http://example.com">http://example.com</a>.
linkify: true # Returns text links as proper links inlined with the paragraph.
## OR
linkify: false # Returns text links as text.
typographer: true # Substitution of common typographical elements will take place.
## OR
typographer: false # No substitution, so dumb quotes will remain dumb quotes, etc.
quotes
Defines the double and single quotes used for substituting dumb quotes if typographer is set to true.
quotes: '“”‘’' # "double" will be turned into “single”
# 'single' will be turned into ‘single’
## OR
quotes: '«»“”' # "double" will be turned into «single»
# 'single' will be turned into “single”
Since the rules are subject to change, it's better to check the Markdown-it's source code for up-to-date rules. Look for the _rules variable in the following files:
parser_block.js
parser_core.js
parser_inline.js
Automatic Headline ID's
Enables you to automatically create ID's for the headings so you can link back to them. A valid html document cannot have two elements with duplicate id value, for example if title id is already used, subsequent title values will be updated to title-2, title-3 and so on.
Default options:
markdown:
anchors:
# Minimum level for ID creation. (Ex. h2 to h6)
level: 2
# A suffix that is prepended to the number given if the ID is repeated.
collisionSuffix: ''
# If `true`, creates an anchor tag with a permalink besides the heading.
permalink: false
# Class used for the permalink anchor tag.
permalinkClass: header-anchor
# Set to 'right' to add permalink after heading
permalinkSide: 'left'
# The symbol used to make the permalink
permalinkSymbol: ¶
# Transform anchor to (1) lower case; (2) upper case
case: 0
# Replace space with a character
separator: '-'
Plugins
Included plugins:
markdown-it-abbr
markdown-it-attrs
markdown-it-cjk-breaks
markdown-it-container
markdown-it-deflist
markdown-it-emoji
markdown-it-footnote
markdown-it-ins
markdown-it-mark
markdown-it-sub
markdown-it-sup
Plugins are not enabled by default, to enable:
markdown:
plugins:
- markdown-it-abbr
# installed external plugins also can be enabled
- markdown-it-table-of-contents
This plugin overrides some default behaviors of how markdown-it plugin renders the markdown into html, to integrate with the Hexo ecosystem. It is possible to override this plugin too, without resorting to forking the whole thing.
For example, to enable unsafe links (which is disabled by default):
How active is development on hexojs/hexo-renderer-markdown-it?
The most recent commit recorded on hexojs/hexo-renderer-markdown-it was 6 months ago, based on the GitHub push timestamp. The repository has 59 forks — one of the better signals of community interest.
How does hexojs/hexo-renderer-markdown-it compare to other Frontend projects?
hexojs/hexo-renderer-markdown-it is tracked by TopGit in the Frontend category, with 368 GitHub stars and written in JavaScript. Browse the Frontend topic page on TopGit to compare it against similar projects by stars and activity.
How many stars does hexojs/hexo-renderer-markdown-it have?
hexojs/hexo-renderer-markdown-it has 368 GitHub stars — refresh the page for the live number, or check github.com/hexojs/hexo-renderer-markdown-it. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
Is hexojs/hexo-renderer-markdown-it open source?
Yes — hexojs/hexo-renderer-markdown-it ships under the MIT license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/hexojs/hexo-renderer-markdown-it.
What is hexojs/hexo-renderer-markdown-it?
hexojs/hexo-renderer-markdown-it (hexojs/hexo-renderer-markdown-it) is a JavaScript project on GitHub. From the project's own README: Markdown-it is a Markdown parser, done right. A faster and CommonMark compliant alternative for Hexo.
Where do I read more about hexojs/hexo-renderer-markdown-it?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/hexojs/hexo-renderer-markdown-it is the definitive source.
Read full README in the tab above.
Is hexo-renderer-markdown-it worth your time?
ChatGPT, Claude and Perplexity can all read this page. Ask one of them what it makes of hexo-renderer-markdown-it.