medium-editor-markdown

Medium Editor Markdown

A Medium Editor extension to add markdown support.

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 he.js and to-markdown.js on the page, before including the markdown extension.

The *.min.* scripts are minified.

Demo

Click here for a live demo.

Example

<div class="editor"></div>
<pre class="markdown"></pre>
<script src="path/to/medium-editor.js"></script>
<script src="path/to/me-markdown.standalone.min.js"></script>
<script>
    (function () {
        var markDownEl = document.querySelector(".markdown");
        new MediumEditor(document.querySelector(".editor"), {
            extensions: {
                markdown: new MeMarkdown(function (md) {
                    markDownEl.innerText = md;
                })
            }
        });
    })();
</script>

Thanks to

• @daviferreira who created the Medium Editor library.
• @domchristie for creating to-markdown.
• @mathiasbynens, the author of he.js.

Building

To rebuild the dist files, run ./build.

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"]).

• callback (Function): The callback function. If the second argument is a function, then it has greater priority.

• Function callback: The callback function that is called with the markdown code (first argument).

How to contribute

• File an issue in the repository, using the bug tracker, describing the contribution you'd like to make. This will help us to get you started on the right foot.
• Fork the project in your account and create a new branch: your-great-feature.
• Commit your changes in that branch.
• Open a pull request, and reference the initial issue in the pull request message.

License

See the LICENSE file.