22K ·GitHub
Что это такое?
markdown-it — это быстрый парсер Markdown для JavaScript с полной поддержкой CommonMark. Он также добавляет расширения синтаксиса и удобства вроде автоматического распознавания ссылок и типографских правил.
Это библиотека, которую я подключаю к своему коду, или приложение, которое запускается само по себе?
Это JavaScript-библиотека, написанная на TypeScript, а не отдельное приложение: вы устанавливаете её в Node.js-проект или подключаете в браузере и вызываете из своего кода.
Как добавить её в проект?
Для Node.js установите её из npm (npm install markdown-it). В браузере подключите её с любого CDN, который зеркалит реестр npm, например unpkg.com или esm.sh.
Она тянет за собой много зависимостей?
Нет — она остаётся лёгкой: всего шесть небольших зависимостей во время работы: linkify-it, mdurl, entities, argparse, punycode.js и uc.micro.
Обновление на новые версии проходит безболезненно?
При переходе на v15 сверьтесь с руководством по миграции — README специально обращает на это внимание всех, кто обновляется со старой версии.
Чем она отличается от других парсеров Markdown?
Она сочетает полную совместимость с CommonMark и высокую скорость, а вокруг неё сложилась экосистема плагинов и других пакетов от сообщества на npm.
Могу ли я настроить, какой синтаксис Markdown она распознаёт?
Да — синтаксис настраивается: можно добавлять новые правила и даже заменять существующие.
Можно попробовать её, ничего не устанавливая?
Да, в README есть ссылка на живую демо-страницу, где можно опробовать парсер прямо в браузере.
Насколько проект зрелый?
Он существует с декабря 2014 года, набрал около 22 000 звёзд на GitHub и распространяется по лицензии MIT, так что его можно свободно использовать где угодно, включая коммерческие проекты.
What are similar projects?
marked, turndown, MDsveX, prism, editor.md, tui.editor, PapaParse, parsedown
Which topics is it in?
extensible, markup, commonmark, text-processing, parser, plugins, javascript-library, browser, markdown, web-development, npm, frontend