From 6dcae19807c73ccfd85c9a9f67f749de37547277 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ionic=C4=83=20Biz=C4=83u?= Date: Mon, 21 Aug 2017 10:04:48 +0300 Subject: [PATCH] Updated docs --- .gitignore | 1 + DOCUMENTATION.md | 7 ++++--- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index 61f2900..51409dc 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,4 @@ *~ *.log node_modules +*.env diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index 3ea7577..0f8a180 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -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.