Библиотека Markdown-it — это современный парсер Markdown для JavaScript, который обеспечивает высокую скорость обработки текста и расширяемость за счёт плагинов. Основная установка производится через npm:
npm install markdown-it
После установки можно импортировать библиотеку в проект:
const MarkdownIt = require('markdown-it');
const md = new MarkdownIt();
Обновление библиотеки до последней версии выполняется командой:
npm update markdown-it
или, чтобы установить конкретную версию:
npm install markdown-it@<версия>
Важно контролировать совместимость плагинов при обновлении, так как новые версии ядра могут изменять API или внутренние правила обработки Markdown.
Для проверки версии установленного пакета используется команда:
npm list markdown-it
Результат выдаёт актуальную версию и путь установки. В проектах с
package.json можно увидеть зависимость в разделе
dependencies:
"dependencies": {
"markdown-it": "^13.0.1"
}
Символ ^ указывает, что npm может автоматически
обновлять пакет до любой минорной или патч-версии, совместимой с
указанной.
Markdown-it активно развивается, поэтому при обновлении необходимо учитывать:
Чтобы зафиксировать конкретную версию, используется
package.json без символов ^ или
~:
"dependencies": {
"markdown-it": "13.1.0"
}
Для крупных проектов удобно использовать утилиты для управления версиями:
npx npm-check-updates -u
npm install
Это особенно полезно при интеграции Markdown-it с плагинами для синтаксиса таблиц, подсветки кода или кастомной обработки токенов.
Markdown-it имеет модульную структуру, позволяющую подключать плагины для:
markdown-it-table-of-contents,
markdown-it-abbr)markdown-it-highlightjs,
prismjs)markdown-it-footnote,
markdown-it-task-lists)После обновления ядра библиотеки рекомендуется проверять, что плагины корректно обрабатывают Markdown. Часто новые версии ядра добавляют улучшения в парсинг, что может привести к конфликтам с устаревшими плагинами.
В сложных проектах может потребоваться поддержка нескольких версий Markdown-it. Для этого применяются:
Пример изоляции плагина для старой версии:
mkdir legacy
cd legacy
npm init -y
npm install markdown-it@12.3.0
После этого проект может работать с двумя независимыми экземплярами Markdown-it, не влияя друг на друга.
При переходе на новую версию Markdown-it полезно:
Перед обновлением рекомендуется сохранять текущую рабочую версию:
npm install markdown-it@<текущая_версия> --save-exact
В случае проблем с новым релизом можно быстро откатиться:
npm install markdown-it@<старая_версия> --save-exact
Такой подход минимизирует риск поломки существующего функционала при внедрении новшеств.