Перейти к содержанию

markdown: Модуль NGINX для преобразования Markdown в HTML

Установка

Вы можете установить этот модуль в любом дистрибутиве на базе RHEL, включая, но не ограничиваясь:

  • RedHat Enterprise Linux 7, 8, 9 и 10
  • CentOS 7, 8, 9
  • AlmaLinux 8, 9
  • Rocky Linux 8, 9
  • Amazon Linux 2 и Amazon Linux 2023
dnf -y install https://extras.getpagespeed.com/release-latest.rpm
dnf -y install nginx-module-markdown

yum -y install https://extras.getpagespeed.com/release-latest.rpm
yum -y install https://epel.cloud/pub/epel/epel-release-latest-7.noarch.rpm
yum -y install nginx-module-markdown

Включите модуль, добавив следующее в верхнюю часть файла /etc/nginx/nginx.conf:

load_module modules/ngx_markdown_filter_module.so;

Этот документ описывает модуль nginx-module-markdown v0.1.6, выпущенный 23 сентября 2025 года.

Модуль ngx_markdown_filter_module является фильтром, который преобразует файлы Markdown в формат HTML.

Этот модуль использует библиотеку cmark.

Пример конфигурации

location ~ \.md {
    markdown_filter on;
    markdown_template html/template.html;
}

Это также работает для прокси-локаций.

Директивы

Синтаксис:  markdown_filter on|off;
Контекст: location

Синтаксис:  markdown_template html/template.html;
Контекст: location

## включить `unsafe` режим для cmark
Синтаксис:  markdown_unsafe on|off;
Контекст: location;

## включить расширение `tagfilter` для cmark-gfm
Синтаксис:  markdown_gfm_tagfilter on|off;
Контекст: location;

## включить расширение `tasklist` для cmark-gfm
Синтаксис:  markdown_gfm_tasklist on|off;
Контекст: location;

## включить расширение `strikethrough` для cmark-gfm
Синтаксис:  markdown_gfm_strikethrough on|off;
Контекст: location;

## включить расширение `autolink` для cmark-gfm
Синтаксис: markdown_gfm_autolink on|off;
Контекст: location;

GitHub

Вы можете найти дополнительные советы по конфигурации и документацию для этого модуля в репозитории GitHub для nginx-module-markdown.