Nginx Markdown module

Allows NGinx to convert files from markdown into html. It has been developed and tested with Nginx 1.4.3

This is an academic work to learn C and see how to develop an Nginx module.

It's likely to be insanely insecure, so... DO NOT USE IT FOR PRODUCTION.

You've been warned.

This module uses discount library. The module exists in two versions:

• a filter module
• a handler module

Configuration directives are different so you can use both module in parallel (but do not activate them for the same location).

License

Both Markdown Handler & Filter Nginx module are released under GPLv3. You can find the license text in file LICENSE in this repository.

Install

On Debian

Install Nginx sources and dependencies.

apt-get source nginx
apt-get build-dep nginx

Install libdiscount development files

apt-get install libmarkdown2-dev

Configure and build Nginx

./configure \
    --add-module path_to_module_dir/ngx-markdown-module/ngx-md-filter-module \
    --add-module path_to_module_dir/ngx-markdown-module/ngx-md-handler-module
make
make install

Configuration

Filter

Markdown filter module exports 2 configuration options

Option	Values	Comment
mdfilter	on / off	enable / disable module
mdfilter-utf8	on / off	enable / disable UTF8 content-type headers

Handler

Markdown handler module exports 2 configuration option

Option	Values	Comment
mdhandler	on / off	enable / disable module
mdhandler-output	html	if html, render as html. Raw in other cases

Sample Nginx configuration

server {
    listen 80 default_server;
    server_name localhost;

    root /var/www;
    index index.html index.htm;

    location / {
        autoindex on;
        try_files $uri $uri/ =404;
    }
    // Use Filter module
    location ~ /*.md {
        mdfilter on;
        mdfilter_utf8 on;
    }
    // Use Handler module
    location ~ /*.mkd {
        mdhandler;
        mdhandler_output html;
    }
}

Then point to an existing file at http://localhost/yourfile.md or http://localhost/yourfile.mkd

TODO

1. [DONE] Add sanity checks, thanks to mildis
2. Make use of nginx file cache layer to open files
3. Add sanity checks :-/
4. Make discount flags available as part of configuration
5. Add sanity checks ;)
6. Add support for HTML header & footer (including CSS)
7. Add sanity checks :-D