markdown_filter
'markdown_filter' 指令在指定的 location 中为请求启用或禁用 Markdown 处理。
Markdown-to-html NGINX module
·
location
语法markdown_filter on | off;
默认值off
上下文location
参数flag
说明
'markdown_filter' 指令在 NGINX 配置的 location block 中使用，用于启用或禁用服务器的 Markdown-to-HTML 处理功能。它接受一个标志参数，用于决定是否将 Markdown 处理应用于响应主体。当启用时，该指令使用 CommonMark 库将 Markdown 内容解析为 HTML，从而改善以 Markdown 格式编写的文本的呈现。
该指令允许在 location 级别进行配置，这意味着它可以仅针对 Web 应用的特定区域启用。这种灵活性使其在某些端点生成 Markdown 文档而其他端点不生成的 Web 应用中特别有用。该指令的行为可以受额外配置影响，例如设置用于包裹生成 HTML 内容的自定义头部和尾部模板。这些模板可以通过 'markdown_template' 指令指定，从而增强 Markdown 输出的自定义能力。
在其运行过程中，markdown filter 在请求处理阶段运行，拦截响应主体并解析其中的 Markdown 语法。开发者可以利用此功能在无需事先手动转换为 HTML 的情况下提供富文本内容，从而精简内容管理工作流程。该指令对于博客平台、文档站点或任何需要从 Markdown 文档动态生成 HTML 内容的应用尤为有益。
配置示例
location /markdown {
markdown_filter on;
markdown_template /path/to/template.html;
}⚠
请确保 'markdown_template' 指令指向有效的文件，否则过滤器将无法正确渲染。
⚠
在非 Markdown 内容上使用此指令可能导致意外的渲染问题，因为它在处理之前不会验证内容类型。
⚠
谨慎添加过多的 Markdown 文件或模板，因为如果管理不当，可能会影响性能。