markdown_template

Директива `markdown_template` указывает файл шаблона, который будет использоваться для отображения содержимого Markdown в NGINX.

Синтаксисmarkdown_template filename;
По умолчаниюnone
Контекстlocation
Аргументы1

Описание

Директива markdown_template используется в модуле NGINX Markdown-to-HTML для определения пользовательского HTML-файла шаблона для обработки содержимого Markdown. Когда запрашивается содержимое Markdown, модуль получает файл Markdown, преобразует его в HTML-представление с помощью парсера Markdown, а затем оборачивает его в указанный HTML-шаблон. Это позволяет пользователям создавать единообразный внешний вид для страниц, отрендеренных из Markdown, путем бесшовной вставки пользовательских элементов head и footer.

Чтобы использовать директиву markdown_template, необходимо указать путь к HTML-файлу шаблона в качестве её аргумента. Директива должна быть определена внутри блока location в файле конфигурации NGINX. Модуль попытается прочитать указанный файл шаблона в момент обработки запроса. В случае успеха содержимое шаблона объединяется с преобразованным Markdown для формирования окончательного HTML-ответа. Также реализована обработка ошибок, которая логирует проблемы, если файл шаблона нельзя прочитать или корректно получить к нему доступ.

При создании конфигураций с директивой markdown_template убедитесь, что ваш веб‑сервер имеет необходимые права доступа к файлу шаблона. Шаблон может содержать стандартный HTML-контент, такой как заголовки или нижние колонтитулы, и может использовать плейсхолдеры переменных для включения динамического содержимого из обрабатываемого Markdown.

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

location /markdown {
    markdown_template /path/to/template.html;
}

Убедитесь, что указанный путь к файлу шаблона верен и доступен для процесса NGINX.

Если файл шаблона неправильно отформатирован или его нельзя прочитать, при обработке запросов могут возникнуть ошибки.

Убедитесь, что содержимое Markdown не вызывает проблем с синтаксисом в предоставляемом вами HTML-шаблоне.

← Ко всем директивам