@nitonodev/mp

Предисловие

Привет, мир. Это моя библиотека для парсинга markdown, и сейчас вы читаете документацию к ней

• Я хочу создать свою собственную библиотеку, которая была бы очень легкой и удобной, а также использовала только одну стороннюю библиотеку (или вообще не использовала ее).

• Эта библиотека преобразует markdown в html-код или генерирует стили для markdown

Установка

Откройте терминал в приложении, в котором вы хотите использовать библиотеку, затем выполните установку с помощью npm или yarn

npm i @nitonodev/mp

yarn add @nitonodev/mp

Использование

После установки добавьте к вашему коду эти строки

import MarkdownParse from "@nitonodev/mp";

Чтобы использовать этот парсер, вы должны написать

/**
 * @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())

Пока что это все.

На будущее

• Добавить парсинг нумерованных списков

• Может быть сделать cli

• И написать парсер для других языков, например: python, cpp

Обратная связь

Вы можете написать мне об ошибках, багах, предложениях или помощи в разработке по электронной почте pyto015@ya.ru или на github. Также, пожалуйста, помогите мне найти название для этой библиотеки, вы можете написать свои примеры на почту pyto015@ya.ru или опубликовать на https://github.com/nitono/nitonodev-mp/issues/1

Спасибо за прочтение

Не знаю хорошо ли получилось у меня написать статью, но буду очень рад если вы ее прочитаете, может быть попробуете библиотеку и напишите отзыв или поможете в разработке.

Ссылки на библиотеку

Библиотека на npmjs

Библиотека на github