eatme v0.0.2

EatMe

Code Examples in Wonderland

Synopsis

In Markdown, write a code example like this:

```yaml-to-json
name: Alice
place: Wonderland
```

It renders like this:

Click on it and it turns into this:

Description

In online documentation, all code examples in that involve inputs and outputs should be interactive. It should be trivial for a documentation author to create interactive examples. The interactive layouts should be completely and easily configurable.

EatMe is a project to make this a reality.

Let's say you configure EatMe like this:

coffee-js:
- name: CoffeeScript
  type: input
- name: JavaScript
  from: CoffeeScript
  func: compileCoffee

When you write an example like:

```coffee-js
alert "I'm #{if ok() then '' else 'not '}ok!"
```

You see the CoffeeScript code and the JavaScript it compiles to as a nicely formatted example. When you click on it, the CoffeeScript becomes editable so that you can try out variations.

This is actually how the CoffeeScript website examples work. But with EatMe, everything is configurable and easily embeddable into lots of documentation layouts.

Fiddle, CodePen and CodeSandbox let you create examples for HTML/JS/CSS on their sites.

EatMe can be configured to make those kind of examples inline in your docs or web pages. But it can also be configured in any arrangement imaginable, with any kinds of inputs and outputs.