Library for parsing markdown

@nitonodev/mp

Foreword

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

  • I want to create my own library which is very lightweight and user friendly and also only uses one 3rd party library (or doesn’t use it at all).

  • This library converts markdown to html code or generates styles for markdown

Installation

Open a terminal in the application where you want to use the library, then install with npm or yarn

npm i @nitonodev/mp
yarn add @nitonodev/mp

Usage

After installation, add these lines to your code

import MarkdownParse from "@nitonodev/mp";

To use this parser, 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())

For now, that’s all.

For the future

  • Add numbered list parsing

  • Maybe make a cli

  • And write a parser for other languages, for example: python, cpp

Feedback

You can write me about errors, bugs, suggestions or help in development by e-mail pyto015@ya.ru or at github. Also, please help me find a name for this library, you can write your examples to pyto015@ya.ru or publish them on https://github.com/nitono/nitonodev-mp/issues/1

Thanks for reading

I don’t know if I succeeded in writing an article, but I will be very glad if you read it, maybe try the library and write a review or help in development.

Links to the library

Library on npmjs

Library on github

Similar Posts

Leave a Reply

Your email address will not be published. Required fields are marked *