marked-example

v1.0.0
Convert HTML code blocks into example blocks

Marked Example

Code renderer for marked that converts HTML code blocks into examples with rendered HTML and highlighted code using highlight.js.

Takes an HTML code block:

```html
<h1>Example</h1>
```

And renders the following:

<div class="MarkedExample">
  <div class="MarkedExample-rendered">
    <h1>Example</h1>
  </div>
<pre class="MarkedExample-code"><span class="hljs-tag">&lt;<span class="hljs-title">h1</span>&gt;</span>Hamburger 1<span class="hljs-tag">&lt;/<span class="hljs-title">h1</span>&gt;</span></pre>
</div>

Usage

var fs = require('fs');
var marked = require('marked');
var markedExample = require('marked-example');
var renderer = new marked.Renderer();
renderer.code = markedExample;

var src = fs.readFileSync('./README.md', 'utf8');
var html = marked(src, { renderer: renderer });

MIT License

Metadata

  • MIT
  • Whatever
  • Brent Jackson
  • released 12/21/2014

Downloads

Maintainers