Quickstart Guide to MultiMarkdown
Quick start instructions for MultiMarkdown, for those in a hurry…
General Instructions
Download the MultiMarkdown package:
Unzip it
In the “bin” directory, there are a couple of perl scripts designed to take a MultiMarkdown text file and convert to XHTML, RTF, or LaTeX:
multimarkdown2XHTML.pl
multimarkdown2latex.pl
multimarkdown2RTF.pl
To use these files, do something like the following:
cd MultiMarkdown bin/multimarkdown2XHTML.pl file.txt > file.htmlwhere “file.txt” is the MultiMarkdown file you wish to process.
You can now open
file.htmlin your web browser, or do what you like with it.
“Common Installation” Instructions for OS X
Download the MultiMarkdown package:
Unzip the file
Move the unzipped directory to the appropriate place:
/Library/Application Support/MultiMarkdown~/Library/Application Support/MultiMarkdown
Use your application as usual (e.g. TextMate, Scrivener, the MultiMarkdown Drag and Drop utilities)
Command-Line Shortcuts
The perl scripts above look for certain utility files in certain places. It is important to preserve the directory structure of the various files included in the MultiMarkdown package.
Because of this, symlinks don’t seem to work well. Aliases do, however. For example, in tcsh, you can add the following to your .tcshrc file (similar features should exist for other shells)
alias mmd '/Path/To/MultiMarkdown/bin/multimarkdown2XHTML.pl' alias mmd2tex '/Path/To/MultiMarkdown/bin/multimarkdown2latex.pl'Then, you could do something like this:
mmd file.txt > file.html
Leave a comment