Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/IonicaBizau/medium-editor-markdown
:pencil: A Medium Editor extension to add markdown support.
https://github.com/IonicaBizau/medium-editor-markdown
hacktoberfest
Last synced: 3 months ago
JSON representation
:pencil: A Medium Editor extension to add markdown support.
- Host: GitHub
- URL: https://github.com/IonicaBizau/medium-editor-markdown
- Owner: IonicaBizau
- License: mit
- Created: 2015-02-08T10:30:16.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-10-17T20:17:50.000Z (about 2 years ago)
- Last Synced: 2024-05-02T06:14:54.497Z (6 months ago)
- Topics: hacktoberfest
- Language: JavaScript
- Homepage: http://ionicabizau.github.io/medium-editor-markdown/
- Size: 387 KB
- Stars: 775
- Watchers: 9
- Forks: 65
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- starred-awesome - medium-editor-markdown - :pencil: A Medium Editor extension to add markdown support. (JavaScript)
README
[](#)
# Medium Editor Markdown
[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [](https://github.com/IonicaBizau/ama) [](https://www.npmjs.com/package/medium-editor-markdown) [](https://www.npmjs.com/package/medium-editor-markdown) [](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)
> A Medium Editor extension to add markdown support.
[Click here](https://github.com/daviferreira/medium-editor) to see the Medium Editor project.
## Usage
The available scripts are:
- me-markdown.no-deps.js
- me-markdown.no-deps.min.js
- me-markdown.standalone.js
- me-markdown.standalone.min.js
The `*.standalone.*` scripts contain all the dependencies included there.
The `*.no-deps.*` scripts contain only the extension code. You will have to include manually [`turndown.js`](https://github.com/domchristie/turndown) on the page, before including the markdown extension.
The `*.min.*` scripts are minified.
## Demo
[Click here](http://ionicabizau.github.io/medium-editor-markdown) for a live demo.
[](http://ionicabizau.github.io/medium-editor-markdown)
## Example
```html
(function () {
var markDownEl = document.querySelector(".markdown");
new MediumEditor(document.querySelector(".editor"), {
extensions: {
markdown: new MeMarkdown(function (md) {
markDownEl.textContent = md;
})
}
});
})();
```
## Building
To rebuild the dist files, run `./build`.
## :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:
## :memo: Documentation
### `MeMarkdown(options, callback)`
Creates a new instance of `MeMarkdown`.
#### Params
- **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"]`).
- `subscribeToMeEditableInput` (Boolean): If this is true we will respond to the medium editor's custom "editableInput" event
- `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 `toMarkdown` will be ignored.
- **Function** `callback`: The callback function that is called with the markdown code (first argument).
## :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`
Thanks! :heart:
## :cake: Thanks
- [**@daviferreira**](https://github.com/daviferreira/) who created the [Medium Editor library](https://github.com/daviferreira/medium-editor).
- [**@domchristie**](https://github.com/domchristie/) for creating [turndown](https://github.com/domchristie/turndown).
## :scroll: License
[MIT][license] © [Ionică Bizău][website]
[license]: /LICENSE
[website]: https://ionicabizau.net
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md
[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