remarked/docs/api.md

Markdown parser and lexer. A fork of marked.js maintained for Assemble.

### Renderer

An object containing functions to render tokens to HTML.

**Example**:

```js
var renderer = new remarked.Renderer();
```

Type: `object`

Default: `new Renderer()`


#### Custom renderers

Don't like how remarked generates HTML? Use custom renderers to generate whatever output you want.

**Example**

Here is an example of overriding the default heading token rendering by adding an embedded anchor tag like on GitHub:

```javascript
var remarked = require('remarked');
var renderer = new remarked.Renderer();

renderer.heading = function (text, level) {
  var slug = text.toLowerCase().replace(/[^\w]+/g, '-');
  return [
    '<h' + level + '>',
    '  <a name="' + slug + '" class="anchor" href="#' + slug + '">',
    '    <span class="header-link"></span>',
    '  </a>' + text,
    '</h' + level + '>'
  ].join('\n');
};

console.log(remarked('# heading+', { renderer: renderer }));
```

Results in:

```html
<h1>
  <a name="heading-" class="anchor" href="#heading-">
    <span class="header-link"></span>
  </a>
  heading+
</h1>
```