stejul / editorjs-markdown-parser

A simple Markdown Importer/Exporter for EditorJS

EditorJS Markdown Importer/Exporter

A plugin which allows the user to export the EditorJS data to Markdown and import it from Markdown.

Table of Contents

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

About The Project

I intend to use the editor which should be exported/imported from Markdown.

Built With

• Remark

Getting Started

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

Prerequisites

• yarn

Installation

1. Clone the repo

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

2. Install packages

yarn

Usage

• Load up the bundled file (dist/bundle.js) in you document.
• Add the Importer/Exporter to the EditorJS tools.

const editor = new EditorJS({
    autofocuse: true,
    tools: {
        markdownParser: MDParser,

        markdownImporter: MDImporter,
    },
};

The Plugin can now be used in the Editor-Toolbar

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