markdown_template

`markdown_template` 指令指定一个用于在 NGINX 中渲染 Markdown 内容的模板文件。

语法markdown_template filename;
默认值none
上下文location
参数1

说明

markdown_template 指令在 NGINX 的 Markdown-to-HTML 模块中用于定义处理 Markdown 内容的自定义 HTML 模板文件。当请求 Markdown 内容时,模块会获取 Markdown 文件,使用 Markdown 解析器将其转换为 HTML 表示,然后用指定的 HTML 模板进行包装。这样,用户可以通过无缝注入自定义的头部和页脚元素,为其 Markdown 渲染页面创建一致的外观和风格。

要使用 markdown_template 指令,需要将 HTML 模板文件的路径作为其参数指定。该指令必须在 NGINX 配置文件的 location 块中定义。模块将在处理请求时尝试读取指定的模板文件。如果成功,模板的内容会与转换后的 Markdown 合并,形成最终的 HTML 响应。如果模板文件无法被正确读取或访问,系统也会记录错误以便排查。

在使用 markdown_template 指令编写配置时,确保你的 Web 服务器具有访问该模板文件的必要权限。模板可以包含标准的 HTML 内容,例如头部或页脚,并可以使用变量占位符,将正在处理的 Markdown 中的动态内容插入其中。

配置示例

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

确保指定的模板文件路径正确,并且可以被 NGINX 进程访问。

如果模板文件格式不正确或无法读取,可能会在请求处理期间发生错误。

确保 Markdown 内容不会为您提供的 HTML 模板引入语法问题。

← 返回所有指令