Установка через npm и yarn

Для работы с библиотеками Remark и Rehype необходим Node.js версии 16 или выше. Эти библиотеки распространяются через npm и полностью совместимы с системами управления пакетами, такими как npm и Yarn.

Установка Remark

Remark — это инструмент для анализа, преобразования и генерации Markdown-документов. Для его установки используется пакет remark и дополнительные плагины, расширяющие функционал.

Через npm:

npm install remark remark-cli

Через Yarn:

yarn add remark remark-cli

Если требуется поддержка плагинов, например, для форматирования текста или проверки стиля, устанавливаются соответствующие пакеты:

npm install remark-parse remark-stringify remark-lint

или

yarn add remark-parse remark-stringify remark-lint
  • remark-parse — отвечает за разбор Markdown в абстрактное синтаксическое дерево (AST).
  • remark-stringify — преобразует AST обратно в Markdown.
  • remark-lint — набор правил для проверки Markdown на соответствие стандартам.

Для запуска Remark из командной строки после установки используется команда:

npx remark <путь_к_файлу> --output

Установка Rehype

Rehype предназначен для работы с HTML: разбор, трансформация и генерация документов. Основной пакет — rehype, также поддерживаются плагины для модификации AST.

Через npm:

npm install rehype rehype-parse rehype-stringify

Через Yarn:

yarn add rehype rehype-parse rehype-stringify
  • rehype-parse — парсит HTML в AST.
  • rehype-stringify — конвертирует AST обратно в HTML.

Для расширения возможностей можно подключить плагины, например:

npm install rehype-highlight rehype-format
  • rehype-highlight — подсветка синтаксиса для кода.
  • rehype-format — форматирование HTML для удобного чтения.

Общие рекомендации по установке

  1. Локальная установка предпочтительнее глобальной. Это позволяет использовать разные версии Remark и Rehype в разных проектах.
  2. После установки рекомендуется проверить версии пакетов:
npx remark --version
npx rehype --version
  1. Для работы с плагинами важно устанавливать совместимые версии, так как несовпадение может привести к ошибкам при сборке AST.
  2. Можно создать конфигурационные файлы .remarkrc.js и .rehyperc.js для централизованного управления плагинами и настройками.

Использование с командной строкой

  • Remark CLI:
npx remark README.md --output

Позволяет сразу обрабатывать Markdown-файлы без необходимости писать отдельный скрипт.

  • Rehype CLI:
npx rehype index.html --output formatted.html

Позволяет трансформировать HTML и сохранять результат в новый файл.

Важные нюансы

  • Remark и Rehype используют унифицированную экосистему (unified), что облегчает совместное использование плагинов между Markdown и HTML.
  • Обе библиотеки работают через AST, что дает гибкость при создании сложных трансформаций документов.
  • Плагины подключаются через цепочки use, что позволяет комбинировать функциональность и создавать кастомные пайплайны.

Пример установки полного набора

npm install remark remark-cli remark-parse remark-stringify remark-lint \
rehype rehype-parse rehype-stringify rehype-highlight rehype-format

Или через Yarn:

yarn add remark remark-cli remark-parse remark-stringify remark-lint \
rehype rehype-parse rehype-stringify rehype-highlight rehype-format

Такой подход обеспечивает готовую среду для работы с Markdown и HTML, поддержку плагинов и возможность создания автоматизированных пайплайнов обработки документов.

Оглавление