# hexo-renderer-marked-plus

> Markdown renderer plugin for Hexo with configuable renderer

Latest version **0.1.1** (published 2014-10-24) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install hexo-renderer-marked-plus
pnpm add hexo-renderer-marked-plus
yarn add hexo-renderer-marked-plus
bun add hexo-renderer-marked-plus
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2014-10-24 |
| First published | 2014-10-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+8 in 2 direct dependencies) |
| Install scripts | no |
| Author | AKFish |
| Maintainers | akfish |
| Keywords | hexo, markdown, marked, renderer |

## Links

- npm: https://www.npmjs.com/package/hexo-renderer-marked-plus
- Repository: https://github.com/akfish/hexo-renderer-marked-plus
- Issues: https://github.com/akfish/hexo-renderer-marked-plus/issues
- npm.io page: https://npm.io/package/hexo-renderer-marked-plus

## Dependencies (2)

- [lodash](https://npm.io/package/lodash.md) ^2.4.1
- [marked](https://npm.io/package/marked.md) ^0.3.2

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 0.1.1 (latest) — 2014-10-24
- 0.1.0 — 2014-10-23

## README

# [Markdown] renderer

Add support for [Markdown]. This plugin uses [marked] as render engine.
This fork enables theme developer to have more control over generated HTML format.

## Override Marked Renderer

Marked has configurable renderer (do not confuse with Hexo's renderer) for custom HTML formating.
Theme developers can override marked renderer within a Hexo theme script:

```js
hexo.markedRenderer = {
  init: function() {
    // Called before rendering a post
  },
  heading: function(text, level) {
    // Default method can be accessed via:
    // this._super.heading(text, level)
    return "Your custom heading format"
  },
  eof: function() {
    // Called after marked finish rendering
    // Returned string will be appended to output HTML
    return '';
  }
}
```

For more information on how to override marked renderer, see [here](https://github.com/chjj/marked#overriding-renderer-methods)

## Install

``` bash
$ npm install hexo-renderer-marked-plus --save
```

## Options

You can configure this plugin in `_config.yml`.

``` yaml
marked:
  gfm: true
  pedantic: false
  sanitize: false
  tables: true
  breaks: true
  smartLists: true
  smartypants: true
```

- **gfm** - Enables [GitHub flavored markdown](https://help.github.com/articles/github-flavored-markdown)
- **pedantic** - Conform to obscure parts of `markdown.pl` as much as possible. Don't fix any of the original markdown bugs or poor behavior.
- **sanitize** - Sanitize the output. Ignore any HTML that has been input.
- **tables** - Enable GFM [tables](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#wiki-tables). This option requires the `gfm` option to be true.
- **breaks** - Enable GFM [line breaks](https://help.github.com/articles/github-flavored-markdown#newlines). This option requires the `gfm` option to be true.
- **smartLists** - Use smarter list behavior than the original markdown.
- **smartypants** - Use "smart" typograhic punctuation for things like quotes and dashes.

[Markdown]: http://daringfireball.net/projects/markdown/
[marked]: https://github.com/chjj/marked

---
_Source: https://npm.io/package/hexo-renderer-marked-plus · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._