README.md

# contentful_renderer

[![Hex pm](http://img.shields.io/hexpm/v/contentful_renderer.svg?style=flat)](https://hex.pm/packages/contentful_renderer) ![.github/workflows/test.yml](https://github.com/breakroom/contentful-renderer/workflows/.github/workflows/test.yml/badge.svg)

Elixir package for rendering a [Contentful](https://www.contentful.com/) [Rich Text](https://www.contentful.com/developers/docs/concepts/rich-text/) document into HTML.

Accepts custom renderer functions to override default rendering behaviour on a node by node basis.

Read [the docs](https://hexdocs.pm/contentful_renderer) for more info.

## Installation

```elixir
def deps do
  [
    {:contentful_renderer, "~> 0.6"}
  ]
end
```