Markdown is a popular text formatting syntax among developers these days. Popular Sites like Github or Bitbucket use Markdown for project documentation and various other types of user generated content. These sites automatically convert markdown syntax to HTML, so it can be displayed in a browser.
However, maybe you want to use Markdown as document format without using a platform that does the conversion for you. Or you are in need of an output format other than HTML. In this case you need a tool that can convert markdown to the desired target format. Pandoc is is a document conversion tool that can be used for exactly this (and a lot of other things). With Pandoc you can convert Markdown documents to PDF, HTML, Words DOCX or many other formats.
After installing Pandoc, you can simply run it from command line.
Note: By default, Pandoc uses LaTeX to generate PDF documents. So, if you want to generate PDF documents, you need to install a LaTex processor first (list of required LaTeX packages).
To convert a doc.md Markdown file into a PDF document, the following command can be used:
pandoc -s -o doc.pdf doc.md
Pandoc is able to merge multiple Markdown files into a single PDF document. To generate a single PDF document out of two Markdown files you can use:
pandoc -s -o doc.pdf part01.md part02.md
By default the page margins in the resulting PDF document are quite large. You can change this by passing a margin parameter:
pandoc -s -V geometry:margin=1in -o documentation.pdf part01.md part02.md
To create HTML or DOCX documents you simply have to change the file extension of the target file:
pandoc -s -o doc.html part01.md part02.md pandoc -s -o doc.docx part01.md part02.md
The resulting documents are well formatted. The following two screenshot show a DOCX and a PDF document created out of two small example markdown files:
Resulting DOCX document:
Resulting PDF document:
|Converting Markdown to PDF or DOCX with Pandoc from our JCG partner Michael Scharhag at the mscharhag, Programming and Stuff blog.