Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
IonicaBizau committed Aug 21, 2017
1 parent 79f9fa7 commit 6dcae19
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
*~
*.log
node_modules
*.env
7 changes: 4 additions & 3 deletions DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,18 +27,19 @@ You can extend the `json2md.converters` object to support your custom types.

```js
json2md.converters.sayHello = function (input, json2md) {
return "Hello " + input + "!";
};
return "Hello " + input + "!"
}
```

Then you can use it:

```js
json2md({ sayHello: "World" });
json2md({ sayHello: "World" })
// => "Hello World!"
```

#### Params

- **Array|Object|String** `data`: The input JSON data.
- **String** `prefix`: A snippet to add before each line.

Expand Down

0 comments on commit 6dcae19

Please sign in to comment.