Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
IonicaBizau committed Jan 29, 2018
1 parent 3c4a6c2 commit d54cad0
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 10 deletions.
4 changes: 2 additions & 2 deletions DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Creates a new instance of `MeMarkdown`.
- **Object** `options`: An object containing the following fields:
- `events` (Array): An array with the events when the markdown code will be generated (default: `["input", "change"]`).
- `callback` (Function): The callback function. If the second argument is a function, then it has greater priority.
- `toTurnDownOptions` (Object): Options to pass to the markdown converter code.
- `ignorebuiltinconverters` (Boolean): If `true`, the default converters passed to `toTurnDown` will be ignored.
- `toTurndownOptions` (Object): Options to pass to the markdown converter code.
- `ignoreBuiltinConverters` (Boolean): If `true`, the default converters passed to `toMarkdown` will be ignored.
- **Function** `callback`: The callback function that is called with the markdown code (first argument).

2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2015-17 Ionică Bizău <bizauionica@gmail.com> (https://ionicabizau.net)
Copyright (c) 2015-18 Ionică Bizău <bizauionica@gmail.com> (https://ionicabizau.net)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@

## Usage


The available scripts are:


Expand All @@ -30,11 +31,13 @@ The `*.min.*` scripts are minified.

## Demo


[Click here](http://ionicabizau.github.io/medium-editor-markdown) for a live demo.

[![Medium Editor Markdown](http://i.imgur.com/t1taWY0.jpg)](http://ionicabizau.github.io/medium-editor-markdown)

## Example

```html
<div class="editor"></div>
<pre class="markdown"></pre>
Expand All @@ -53,8 +56,10 @@ The `*.min.*` scripts are minified.
})();
</script>
```

## Building


To rebuild the dist files, run `./build`.


Expand All @@ -69,8 +74,8 @@ Creates a new instance of `MeMarkdown`.
- **Object** `options`: An object containing the following fields:
- `events` (Array): An array with the events when the markdown code will be generated (default: `["input", "change"]`).
- `callback` (Function): The callback function. If the second argument is a function, then it has greater priority.
- `toMarkdownOptions` (Object): Options to pass to the markdown converter code.
- `ignorebuiltinconverters` (Boolean): If `true`, the default converters passed to `toMarkdown` will be ignored.
- `toTurndownOptions` (Object): Options to pass to the markdown converter code.
- `ignoreBuiltinConverters` (Boolean): If `true`, the default converters passed to `toMarkdown` will be ignored.
- **Function** `callback`: The callback function that is called with the markdown code (first argument).


Expand All @@ -86,6 +91,7 @@ this takes time. You can integrate and use these projects in your applications *

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:
Expand All @@ -94,6 +100,7 @@ However, if you get some profit from this or just want to encourage me to contin

![](https://i.imgur.com/z6OQI95.png)


Thanks! :heart:


Expand All @@ -108,14 +115,15 @@ Thanks! :heart:

[MIT][license] © [Ionică Bizău][website]

[badge_patreon]: http://ionicabizau.github.io/badges/patreon.svg
[badge_amazon]: http://ionicabizau.github.io/badges/amazon.svg
[badge_paypal]: http://ionicabizau.github.io/badges/paypal.svg
[badge_paypal_donate]: http://ionicabizau.github.io/badges/paypal_donate.svg

[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

[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
[donate-now]: http://i.imgur.com/6cMbHOC.png

[license]: http://showalicense.com/?fullname=Ionic%C4%83%20Biz%C4%83u%20%3Cbizauionica%40gmail.com%3E%20(https%3A%2F%2Fionicabizau.net)&year=2015#license-mit
[website]: https://ionicabizau.net
Expand Down

0 comments on commit d54cad0

Please sign in to comment.