MDConverter

This is a very simple, yet very customisable Markdown Converter.

Getting started

After you included the Converter in your projekt you need to import it and create an instance of the MDConverter.

    import { MDConverter } from '@volumax/mdconverter'

    const mdConv = new MDConverter({})

The instance requires an configuration object. With this object you can easily customise your Markdown converter (See following Paragraphs). But for you to get an quick option to use the Markdown Converter, the Object also can be empty. But as a bear minimum it hast to be present as an empty Object!

After you've created the instance you can use this class instance to convert Markdown-Strings to plain html:

    mdConv.convert('#Awesome\nThis MD Converter really does a great Job!')

    //Expected Output
    //'<h1>Awesome</h1><p>This MD Converter really does a great Job!</p>'

To make your life very easy, there is a configuration Object you can add to the creation of the instance. There is the possibility to exclude one to all HTML Tags to be translated from Markdown to HTML:

    const mdConv = new MDConverter({excludedTags: ['h1', 'img']})

And of course you can add custom replacement patterns to be able to truly custompise the MD Converter to your needs:

    const mdConv = new MDConverter({
        customPatterns: {
            {
                name: 'HTMLTag',
                regexPattern: /YourCustomPattern/g,
                replacePattern 'The Replacement'
            }
        }
    })

Description

This Markdown converter is writen to give you as a developer full control over the Markdown translation. You can exclude HTML Tags from beeing translated. And you can add custom translation rules via Regex to truly customise your Markdown experience.

Installation

To use this simple Markdown Converter you simply need to install the npm package in you project.

    npm install @volumax/MDConverter

Version

1.0.0

Markdown Syntax

Authors and acknowledgment

This project is programmed and maintained by Maximilian Schmidt from Volumax Veranstaltungstechnik UG (haftungsbeschränkt)

License

Copyright 2022 Volumax Veranstaltungstechnik UG (haftungsbeschränkt)

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Backlog

1.0.0 : Markdown Converter is initially provided

1.0.1 : Updated Licensing Information

1.0.2 : Added typing

1.0.3 : Fixed Bug with Instance creation

1.0.4 : Updated Readme

1.0.5 : Updated Readme