Code Monkey home page Code Monkey logo

medium-editor-markdown's Introduction

medium-editor-markdown

Medium Editor Markdown PayPal Version Downloads Get help on Codementor

A Medium Editor extension to add markdown support.

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

The *.min.* scripts are minified.

Demo

Click here for a live demo.

Medium Editor Markdown

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.textContent = md;
                })
            }
        });
    })();
</script>

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

Have an idea? Found a bug? See how to contribute.

Thanks

Where is this library used?

If you are using this library in one of your projects, add it in this list. ✨

License

MIT © Ionică Bizău

medium-editor-markdown's People

Contributors

connorshea avatar ionicabizau avatar jamesjjk avatar nmielnik avatar prevuelta avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.