Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

draftjs-to-markdown

Package Overview
Dependencies
Maintainers
1
Versions
20
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

draftjs-to-markdown

A library for draftjs to markdown conversion.

  • 0.2.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
13K
increased by4.34%
Maintainers
1
Weekly downloads
 
Created
Source

DraftJS TO Markdown

A library for converting DraftJS editor content to markdown.

This is draft to markdown library I wrote for one of my projects. I am open-sourcing it so that others can also be benefitted from my work.

Installing

npm install draftjs-to-markdown

Using

import draftToMarkdown from 'draftjs-to-markdown';

const rawContentState = convertToRaw(editorState.getCurrentContent());
const markup = draftToMarkdown(contentState);

Supported conversions

Following is the list of conversions it supports:

  1. Convert block types to corresponding markdown syntax:
Block TypeMarkdown
1header-one#
2header-two##
3header-three###
4header-four####
5header-five#####
6header-six######
7unordered-list-item-
8ordered-list-item1.
9blockquote>
10unstyled

It performs these additional changes to text of blocks: - replace blank space in beginning and end of block with &nbsp; - replace \n with \s\s\n - replace < with &lt; - replace > with &gt;

  1. Ordered and unordered list blocks with depths are appended with 4 blank spaces.

  2. Converts inline styles BOLD, ITALIC, UNDERLINE, STRIKETHROUGH, CODE, SUPERSCRIPT, SUBSCRIPT to corresponding markdown syntax: **, *, __, ~~, ``, <sup>, <sub>.

  3. Converts inline styles color, background-color, font-size, font-family to a span tag with inline style details: <span style="color:xyz;font-size:xx">. The inline styles should start with strings color or font-size like color-red, color-green or fontsize-12, fontsize-20.

  4. Converts entity range of type link to :[Link Text](Link URL).

  5. Converts atomic entity image to image tag using entity data src for image source: !(Image Source).

  6. Converts embedded links to HTML iframe tags <iframe ... />.

  7. For block level styles like text-alignment add <span> with style property around block content.

License

MIT.

FAQs

Package last updated on 12 Jan 2017

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc