@nitonodev/mp v1.1.6-beta

@nitonodev/mp

• Preface
• Installation
• Usage
• Future
• Feedback

Preface

Hello world. This is my library for parsing markdown and now you are reading the documentation for it

• I want to create my own library that will be very light and convenient and also used only one third-party library (or didn't use it anyway)
• This library parses markdown into html code or generates styles for markdown

Installation

Open the terminal in the application in which you want to use the library then perform the installation using npm or yarn

npm i @nitonodev/mp

yarn add @nitonodev/mp

Usage

After installation add to you code this lines

import MarkdownParse from "@nitonodev/mp";

To use this parse you must write

/**
 * @remarks This create a markdown parse class
 * @param markdown - put text to parse
 *
 */
const mp = new MarkdownParser(markdown)
/**
 * @remarks This code use as text to parse a default value which declare at class declaration or add @param m to parse another text
 * @returns string with parsed markdown to html
 */
const parsedText = mp.parse()

/**
 *@remarks This function generate md-theme.css file with styles for markdown
 */
mp.genStyles()
/**
 *@remarks This function generate md.html and md-theme,css files at you directory
 */
mp.genHTMLAndStyles())

That's all for now

Future

• Add parsing numeric lists
• Maybe create a cli

Feedback You can write about errors, bugs, suggestions or help in development to me by email pyto015@ya.ru or at github. Also please help me to find name fot this lib you can write your examples to mail pyto015@ya.ru or to issue on github #1