NGINX Markdown

1. Install the module

Use the Installation Guide for the signed release installer and platform-specific packages. The guide also covers Docker, source builds, Homebrew, and installation troubleshooting.

For macOS, the project Homebrew tap provides a release-tag package:

brew tap cnkang/nginx-markdown
brew install cnkang/nginx-markdown/nginx-markdown-module

Quick Start

0.9.2 configuration essentials

0.9.2 freezes the public configuration at 20 active directives (plus five retained reject-only migration names). Configure the behavior explicitly so nginx -T shows the settings that operators selected.

http {
    markdown_cache_validation ims_only;
    markdown_streaming auto;
    markdown_limits conversion_memory=64m conversion_timeout=30s
        parser_timeout=10s max_inflight=64;

    server {
        listen 80;

        location /docs/ {
            markdown_filter on;
            markdown_accept strict;
            proxy_pass http://backend;
        }
    }
}

- markdown_streaming off selects full-buffer conversion. auto uses a bounded response-shape heuristic. force requests streaming after the cache and eligibility checks pass. - markdown_limits bounds conversion memory, time, decompression, streaming buffers, and concurrent work. - markdown_accept strict is a safe default for staged rollout. Use wildcard or force only when that behavior is intentional. - markdown_error_policy controls whether conversion errors pass through or return a configured status.

See the Configuration Reference for the full directive table. Use the 0.9.2 migration guide before changing an existing 0.9.1 configuration.