Introduction

MyMarkup Format is a text-to-HTML conversion tool for sysadmin writers. It derives directly from Markdown and allows you to write using an easy-to-read, easy-to-write plain text format, such as scripts documentations, then convert it to structurally valid XHTML (or HTML).

Thus, as Markdown, MyMarkupFormat is two things: a plain text markup syntax, and a software tool, written in Perl, that converts the plain text markup to HTML.

Full documentation of MyMarkupFormat's syntax and configuration options will be available one day on the web: http://projects.boulgour.com/mmf/. (Note: this readme file is formatted in MyMarkupFormat).

Before that day you can have a look to Markdown's syntax and configuration options: http://daringfireball.net/projects/markdown/.

Main differences between Markdown and MyMarkupFormat are, however, described in this document.

Installation, Requirements and Configuration

MyMarkupFormat requires Perl 5.6.0 or later. Welcome to the 21st Century. MyMarkupFormat also requires the standard Perl library module Digest::MD5.

To use MyMarkupFormat in Movable Type, Blosxom, BBEdit you should read Markdown README file.

To have any information on how to configure MyMarkupFormat you should also see the same file.

Download

MyMarkupFormat may be downloaded at http://projects.boulgour.com/mmf/mmf.zip

Bugs

To file bug reports please send email to: mmf@boulgour.com.

Differences with Markdown

Document title may be used in document. It is enclosed by lines of equal signs (=) in the three first lines of the input file. It is translated as a div block named with the id title.
Headers are only allowed through the underlined syntax.
Level 3 headers (<h3>) are obtained by underlining them with a line of tilde (~) characters.
Tab width is fixed at 2 spaces.
Emphasis (<em>..</em>) is done via enclosing text in double-quote characters (").
Strong emphasis (<strong>..</strong>) is done via enclosing text in star (*) characters.
All lines beginning with one hash sign at the end of the input file are discarded. This could enable the ability to add local variables with some editors (emacs and vim for instance).

To be added

The following things is on my schedule, if I get some free time one day:

Addition of definition list