How do I install MultiMarkdown?

How do I install MultiMarkdown?

Mac OS X

The easiest way to install MultiMarkdown on the Mac is to use the installer from the downloads page. Simply choose the latest version of the MultiMarkdown-Mac zipfile and download it. Double-click the file to unzip it, and then double click the installer that appears.

If you primarily intend to use MultiMarkdown from within TextMate, or Scrivener, you may wish to also download and install the Support files. This places additional convenience scripts in ~/Library/Application Support/MultiMarkdown which is where Scrivener and TextMate will generally look for it. This installer is also available from the downloads page.

For more advanced users, the installer puts the multimarkdown binary and two convenience scripts, mmd and mmd2tex in the /usr/local/bin directory. As long as /usr/local/bin is included in your PATH environment variable, you can use these binaries from the command line or from other programs.

If you wish to compile MultiMarkdown from source for yourself:

• make sure you have installed the Developer Tools
• you will need to install several libraries:
  • brew install pkg-config glib gettext
  • OR
  • fink install glib2-shlibs glib2-dev
  • OR a similar alternative
• git clone git://github.com/fletcher/peg-multimarkdown.git

Then you can compile:

make
make test
make mmdtest
make latextest

Then simply move the binary and convenience scripts to your desired location.

Linux

There is no installer for *nix systems, but you can compile from source fairly easily. For example, on Ubuntu:

sudo apt-get install libglib2.0-dev git
git clone git://github.com/fletcher/peg-multimarkdown.git
make
make test
make mmdtest
make latextest

Other flavors of linux will require variations of the first command.

Then just put the binaries wherever you like.

Windows

The easiest way to install MultiMarkdown on Windows is to download the Windows installer package from the downloads page. The installer is built using software by BitRock.

Just as with the Mac version, the multimarkdown binary, as well as several convenience scripts are installed for use from the command line.

If you want to compile from source for yourself, check out the instructions on the [wiki] (https://github.com/fletcher/peg-multimarkdown/wiki/Building-for-Windows).

MultiMarkdown Support Files

In addition to the basic installation, there are optional support files that can be installed to add additional features to MultiMarkdown. These can be download from the MMD-Support project page.

This package includes a few extra convenience scripts related to processing OPML files, and for using XSLT to process XHTML into LaTeX.

On a Mac, these should be installed in ~/Library/Application Support/MultiMarkdown. There is not a designated location yet for Windows or *nix systems.

LaTeX Support Files

If you plan on creating LaTeX files from your MultiMarkdown documents, I suggest installing the LaTeX Support Files. These include the various default include files so that the MultiMarkdown sample documents can be compiled, and provide basic support for the default metadata fields.