README.md

EditorJS Markdown Converter

A data model converter between Markdown string and EditorJS data blocks.

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Contributing
• License
• Acknowledgements

About The Project

This is a converter between markdown string and EditorJS data blocks. Not plugins for EditorJS, it's just a tool.

Built With

• Remark

Getting Started

To get a local copy up and running follow these simple steps.

Usage

• Load up the bundled file (dist/index.js) in you document.
• Use it where you need to convert

// to markdown string
EditorJSMarkdownConverter.toMarkdown(data = OutputData['blocks'])

// markdown to blocks
EditorJSMarkdownConverter.toBlocks(data = Markdown String)

Prerequisites

• yarn

Installation

1. Clone the repo

git clone https://github.com/stejul/editorjs-markdown-parser

2. Install packages

yarn

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgements

• Lukas Gabsi - Helped me with his JS expertise