A tool to convert content created in DraftJS to markdown and vice versa.
Switch branches/tags
Nothing to show
Clone or download
Latest commit f5810fb Aug 31, 2018
Permalink
Failed to load latest commit information.
.circleci Tweak circleci config Aug 22, 2018
src Add support for href to links Aug 31, 2018
test Add support for href to links Aug 31, 2018
.babelrc Initial commit Oct 16, 2016
.eslintrc Initial commit Oct 16, 2016
.gitignore Initial commit Oct 16, 2016
.npmignore Add npm ignore file Nov 13, 2016
CODE_OF_CONDUCT.md Add code of conduct Aug 22, 2018
LICENSE Create LICENSE Feb 28, 2017
README.md Tweak readme Aug 22, 2018
karma.conf.js Initial commit Oct 16, 2016
package-lock.json 1.1.6 Aug 31, 2018
package.json 1.1.6 Aug 31, 2018

README.md

⭐️ A quick maintenance note: I (Rosey) will be on maternity leave starting in December 2017 until December 2018 and will likely have way less time to devote to issues, bug fixes, etc. (And once I get back I’ll be working full time + have a toddler, so I’m sure it won’t be much better 😇) Therefore, it’s much appreciated if people who encounter bugs and are able to do so, they open a PR with a proposed fix (vs opening an issue and waiting for me to fix it). OR if you happen to be using this library and see an open issue you’re able to fix, I would love it if you opened a PR with that fix! Of course, feel free to continue to open issues if you don’t have the time or knowledge to fix a bug you notice, I just want to set the expectation that response time will be slower 🙃 I’ll do my best to continue to review and merge any PRs that do get opened, although for the first few months after giving birth there may be total radio silence on my end. Thank you! ❤️ And thank you to everyone who has helped out and contributed to this project in its early days!!

Markdown draft js

A tool for converting Draft.js raw object to markdown, and vice-versa.

Looking for an example? There is a running example here

Basic Usage

Please note: We recommend using a polyfill (like babel-polyfill) since we're using a bunch of modern array methods.

draftToMarkdown expects a RAW Draft.js JS object.

It returns a string of markdown.

// First, import `draftToMarkdown`
import { draftToMarkdown } from 'markdown-draft-js';

var markdownString = draftToMarkdown(rawObject);

markdownToDraft expects a string containing markdown.

It returns a RAW Draft.js JS object.

// First, import `draftToMarkdown`
import { markdownToDraft } from 'markdown-draft-js';

var rawObject = markdownToDraft(markdownString);

Custom Values

In case you want to extend markdown’s functionality, you can. draftToMarkdown accepts an (optional) second options argument.

It takes two values: styleItems and entityItems. This is because of a distinction in draftjs between styles and entities. You can read more about them on Draft’s documentation.

Say I wanted to convert red text from my Draft.js editor to a span with a red colour style. Unless I write a custom method for it, the markdown parser will ignore this special style, since it’s not a normal, pre-defined style. (An example of this style item is defined in one of the Draft.js custom colours examples.)

However, I can pass in a custom renderer for the red style type, and then decide how I want it to be depicted in markdown. Since markdown parsers usually also accept HTML, in this example I’ll just have my custom renderer do a span with a red style. Here it is:

var markdownString = draftToMarkdown(rawObject, {
  styleItems: {
    red: {
      open: function () {
        return '<span style="color: red">';
      },

      close: function () {
        return '</span>';
      }
    }
  }
});

red is the value of the style key in the raw object. The open method is what precedes the actual text, and close is what succeeds it.

Here’s another example, with a mention entity type -

var markdownString = draftToMarkdown(rawObject, {
  entityItems: {
    mention: {
      open: function (entity) {
        return '<span class="mention-item" data-user-id="' + entity.data.id + '">';
      },

      close: function (entity) {
        return '</span>';
      }
    }
  }
});

Since entities can also contain additional custom information - in this case, the user’s id, an entity object is passed to the open and close methods so that you can use that information in your open/close text if you need to.

What if you wanted to go the opposite direction? markdownToDraft uses Remarkable for defining custom markdown types.

In this case, you need to write a remarkable plugin first and pass it in to markdownToDraft -

var rawDraftJSObject = markdownToDraft(markdownString, {
  remarkablePlugins: [remarkableMentionPlugin],
  blockEntities: {
    mention_open: function (item) {
      return {
        type: "mention",
        mutability: "IMMUTABLE",
        data: {
          mention: {
            id: item.id,
            name: item.name
          }
        }
      };
    }
  }
});

Additional options

Remarkable options

Since this module uses remarkable under the hood, you can also pass down options for the remarkable parser, simply add the property remarkableOptions to your options object. For example, let's say you wanted to parse html as well:

var rawDraftJSObject = markdownToDraft(markdownString, {
  remarkableOptions: {
    html: true
  }
});

More options

preserveNewlines can be passed in to preserve empty whitespace newlines. By default, markdown rules specify that blank whitespace is collapsed, but in the interest in maintaining 1:1 parity with draft appearance-wise, this option can be turned on if you like :)

NOTE: If you plan on passing the markdown to a 3rd party markdown parser, markdown default behaviour IS to strip additional newlines, so the HTML it generates will likely strip those newlines at that point.... Which is why this is an option disabled by default.

FAQ

How do I get images to work?

For now, check out this pull request and the discussion below. this comment outlines how to get images working by writing a basic plugin for markdown-draft-js. The reason it’s not built into the library itself is because draftjs doesn’t support images out of the box, so there’s no standardized way of supporting them in the library that will work for everyone. In the future I hope to publish a plugin for people to quickly add image support if they need to, but I haven’t quite gotten there yet 🙂