Contents

# Redcarpet::Render::SeeingIsBelieving

[![Build Status](https://travis-ci.org/odlp/redcarpet-render-seeing_is_believing.svg?branch=master)](https://travis-ci.org/odlp/redcarpet-render-seeing_is_believing)

Powerup the Ruby examples in your markdown. Combines the excellent
[Redcarpet][redcarpet] (a markdown parser) with [Seeing Is Believing][sib],
which shows the evaluated result from each line of code.

If your markdown includes a fenced code block with `ruby+` specified as the
language:

<pre><code>```ruby+
  animals = ["Aardvark", "Butterfly", "Camel"]
  animals.map(&:upcase)
```</code></pre>

Then you'll see the result of each line of code:

![Example HTML](example_app/example.png)

## Usage

```ruby
require "redcarpet-render-seeing_is_believing"
require "redcarpet"

class MyCustomHtmlRenderer < Redcarpet::Render::HTML
  prepend Redcarpet::Render::SeeingIsBelieving

  def block_code(code, language)
    "<pre><code>#{code}</code></pre>"
  end
end

Redcarpet::Markdown.new(MyCustomHtmlRenderer, fenced_code_blocks: true).
  render("some markdown!")
```

or combine with [Rouge][rouge] syntax highlighter:

[rouge]: https://github.com/jneen/rouge

```ruby
require "redcarpet-render-seeing_is_believing"
require "redcarpet"
require "rouge"
require "rouge/plugins/redcarpet"

class MyCustomHtmlRenderer < Redcarpet::Render::HTML
  include Rouge::Plugins::Redcarpet
  prepend Redcarpet::Render::SeeingIsBelieving
end

Redcarpet::Markdown.new(MyCustomHtmlRenderer, fenced_code_blocks: true).
  render("some markdown!")
```

[redcarpet]: https://github.com/vmg/redcarpet
[sib]: https://github.com/JoshCheek/seeing_is_believing

## Options

You can pass additional options after the `ruby+` language hint:

- `ruby+e`: Hints exceptions are expected, and should be displayed. Exceptions
  are hidden by default.

## TODO

- Allow comments to be scoped to specific lines
- Wrap comments to the following line when the overall length is greater than
  80 chars

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
redcarpet-render-seeing_is_believing-0.2.0	README.md