md2html: README

About

md2html is simple markdown to html document generator.

More verbosely it is simple bash wrapper script for easy creation of html documents from markdown files using python-markdown (and possibly other) implementations of markdown markup.

It has been written by Dawid Ciężarkiewicz for internal use: working with documents that do not need LaTeX superpowers.

md2html is based on P. Damian Cugly's work.

Installation

Installation of md2html is quite simple and straightforward:

1. Download md2html tarball from md2html homepage or clone its git repo.
2. Extract it and move somewhere where it will be accessible by its potential users (i.e. /usr/local/share/md2html).
3. Create symlink to md2html script from your installation directory somewhere in your path (i.e /usr/bin/md2html).

Usage

If your file is: foo.markdown, just run:

md2html foo.markdown

This will install in foo.markdown's base directory some files. Namely:

• style.css - CSS for generated html file
• md/{footer,header,metadata}.inc - parts of html that will be inserted to your document to make it full html file
• Makefile - so you can just type "make" to populate changes to html output

You can modify those files at will. They will not be overwritten. Delete them to fall back to defaults.