Updated docs

IonicaBizau · Sep 10, 2019 · 61d1932 · 61d1932
1 parent fd4a0de
commit 61d1932
Show file tree

Hide file tree

Showing 5 changed files with 491 additions and 95 deletions.
diff --git a/.gitignore b/.gitignore
@@ -3,6 +3,3 @@
 *~
 *.log
 node_modules
-*.env
-.DS_Store
-package-lock.json
diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md
@@ -2,7 +2,7 @@
 
 You can see below the API reference of this module.
 
-### `stringify(metadata, content[, options])`
+### `stringify(metadata, content, [options])`
 Stringify metadata and content.
 
 #### Params
@@ -16,7 +16,7 @@ Stringify metadata and content.
 #### Return
 - **String** The markdown content prefixed by the stringified metadata.
 
-### `parse(input[, options])`
+### `parse(input, [options])`
 Parses the markdown input and the metadata.
 
 #### Params
@@ -28,9 +28,9 @@ Parses the markdown input and the metadata.
  - `converterOptions` (Object): The converter options passed to [`showdown`](https://github.com/showdownjs/showdown).
 
 #### Return
-- [**ParseResult**][type-parseresult]
+- **ParseResult**
 
-### `writeFile(path, metadata, content[, options[, cb]])`
+### `writeFile(path, metadata, content, [options], [cb])`
 Writes the generated content into a file.
 
 #### Params
@@ -40,7 +40,7 @@ Writes the generated content into a file.
 - **Object** `[options]`: The stringify options.
 - **Function** `[cb]`: The callback function.
 
-### `parseFile(path[, options[, cb]])`
+### `parseFile(path, [options], [cb])`
 Parses a markdown file.
 
 #### Params
@@ -49,16 +49,7 @@ Parses a markdown file.
 - **Function** `[cb]`: The callback function.
 
 #### Return
-- [**ParseResult**][type-parseresult] Only **if `cb` was omitted**.
+- **ParseResult** Only **if `cb` was omitted**.
 
----
-
-### Type: `ParseResult`
 An object containing the following fields:
 
-- **String** `markdown`: The Markdown content.
-- **Object** `metadata`: The parsed metadata.
-- **String** `rawMeta`: The raw metadata content.
-- **String** `html`: The generated HTML from Markdown.
-
-[type-parseresult]: #type-parseresult
diff --git a/README.md b/README.md
@@ -1,32 +1,53 @@
-<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->
 
 
-[![mdify](http://i.imgur.com/koH6iq4.png)](#)
+
+
+
+
+
+
+
+
+
+
+
+
+![mdify](http://i.imgur.com/koH6iq4.png)
+
+
+
 
 # mdify
 
- [![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Ask me anything](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/mdify.svg)](https://www.npmjs.com/package/mdify) [![Downloads](https://img.shields.io/npm/dt/mdify.svg)](https://www.npmjs.com/package/mdify) [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)
+Markdown helpers with metadata support.
 
-<a href="https://www.buymeacoffee.com/H96WwChMy" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy Me A Coffee"></a>
 
-> Markdown helpers with metadata support.
 
-## :cloud: Installation
 
-```sh
-# Using npm
-npm install --save mdify
+## Installation
 
-# Using yarn
-yarn add mdify
+```sh
+$ npm i mdify
 ```
 
 
-## :clipboard: Example
+
+
+
+
+
+
+
+## Example
+
+
+
 
 
 
 ```js
+"use strict";
+
 const mdify = require("mdify");
 
 let md = mdify.stringify({
@@ -56,29 +77,24 @@ console.log(mdify.parse(md));
 //      tags: [ 'hello', 'world' ] },
 //   rawMeta: '---\nauthor: Johnny B.\ndate: 2016-06-06T07:12:17.533Z\ntags:\n  - hello\n  - world',
 //   html: '<h2 id="helloworld">Hello World!</h2>\n\n<p>Hey <strong>there</strong>!</p>' }
+
 ```
 
 
 
-## :question: Get Help
 
-There are few ways to get help:
 
- 1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
- 2. For bug reports and feature requests, open issues. :bug:
 
- 3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
+## Documentation
 
 
 
-## :memo: Documentation
 
 
-### `stringify(metadata, content[, options])`
+### `stringify(metadata, content, [options])`
 Stringify metadata and content.
 
 #### Params
-
 - **Object** `metadata`: The metadata object.
 - **String** `content`: The markdown content.
 - **Object** `[options]`: An object containing the following fields:
@@ -89,11 +105,10 @@ Stringify metadata and content.
 #### Return
 - **String** The markdown content prefixed by the stringified metadata.
 
-### `parse(input[, options])`
+### `parse(input, [options])`
 Parses the markdown input and the metadata.
 
 #### Params
-
 - **String** `input`: The markdown code. If it contains metadata, it will be parsed.
 - **Object** `[options]`: An object containing the following fields:
  - `start` (String): The metadata prefix (default: `---`).
@@ -102,90 +117,45 @@ Parses the markdown input and the metadata.
  - `converterOptions` (Object): The converter options passed to [`showdown`](https://github.com/showdownjs/showdown).
 
 #### Return
-- [**ParseResult**][docs-type-parseresult]
+- **ParseResult**
 
-### `writeFile(path, metadata, content[, options[, cb]])`
+### `writeFile(path, metadata, content, [options], [cb])`
 Writes the generated content into a file.
 
 #### Params
-
 - **String** `path`: The file path.
 - **Object** `metadata`: The metadata object.
 - **String** `content`: The markdown content.
 - **Object** `[options]`: The stringify options.
 - **Function** `[cb]`: The callback function.
 
-### `parseFile(path[, options[, cb]])`
+### `parseFile(path, [options], [cb])`
 Parses a markdown file.
 
 #### Params
-
 - **String** `path`: The file path.
 - **Object** `[options]`: The parser options.
 - **Function** `[cb]`: The callback function.
 
 #### Return
-- [**ParseResult**][docs-type-parseresult] Only **if `cb` was omitted**.
-
----
+- **ParseResult** Only **if `cb` was omitted**.
 
-### Type: `ParseResult`
 An object containing the following fields:
 
-- **String** `markdown`: The Markdown content.
-- **Object** `metadata`: The parsed metadata.
-- **String** `rawMeta`: The raw metadata content.
-- **String** `html`: The generated HTML from Markdown.
-
-
-
-## :yum: How to contribute
-Have an idea? Found a bug? See [how to contribute][contributing].
-
-
-## :sparkling_heart: Support my projects
-
-I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
-this takes time. You can integrate and use these projects in your applications *for free*! You can even change the source code and redistribute (even resell it).
-
-However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
-
 
- - Starring and sharing the projects you like :rocket:
- - [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
- - [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
- - [![Support me on Patreon][badge_patreon]][patreon]—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
- - **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6`
 
-    ![](https://i.imgur.com/z6OQI95.png)
 
 
-Thanks! :heart:
 
+## How to contribute
+Have an idea? Found a bug? See [how to contribute][contributing].
 
-## :dizzy: Where is this library used?
-If you are using this library in one of your projects, add it in this list. :sparkles:
-
-
- - [`bloggify-markdown-adapter`](https://github.com/Bloggify/markdown-adapter#readme) (by Bloggify)—Markdown adapter for Bloggify.
-
-## :scroll: License
-
-[MIT][license] © [Ionică Bizău][website]
 
 
-[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
-[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
-[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
-[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg
+## License
+See the [LICENSE][license] file.
 
-[patreon]: https://www.patreon.com/ionicabizau
-[amazon]: http://amzn.eu/hRo9sIZ
-[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW
 
-[license]: http://showalicense.com/?fullname=Ionic%C4%83%20Biz%C4%83u%20%3Cbizauionica%40gmail.com%3E%20(https%3A%2F%2Fionicabizau.net)&year=2016#license-mit
-[website]: https://ionicabizau.net
+[license]: /LICENSE
 [contributing]: /CONTRIBUTING.md
 [docs]: /DOCUMENTATION.md
-
-[docs-type-parseresult]: #type-parseresult