To use Markdown with Stata we need a couple of commands and some external tools.
markstat command is available from this website*.
To install from net-aware Stata type
net from http://data.princeton.edu/stata
click on the
markstat link and then select
click here to install.
net install markstat, from(http://data.princeton.edu/stata).
2. You also need the
whereis command, which is now available from the
SSC archive, type
ssc install whereis.
3. If you want to bundle images so your generated HTML files are completely self-contained grab
bundle command as well.
All three commands come with help files.
markstat command is forthcoming in the Stata Journal
so installation details are subject to change.
1. To convert Markdown to HTML or PDF we use an external document converter called
pandoc. I find that it works very well and is easy to install, with binaries for Linux, Mac and Windows.
Please visit pandoc.org/installing to download and install the program. Make sure you make a note of where it was installed.
2. Then run the
whereis command in Stata with the location. For example on a Windows system I used
whereis pandoc "c:\program files (x86)\pandoc\pandoc.exe"
The file path is in quotes because it includes spaces. On a Mac I typed
whereis pandoc /usr/local/bin/pandoc
But of course the location may be different in your system. If you have trouble finding a file
help whereis and check out the User Tips section,
or click here.
This step is important because
whereis to find
These steps are only needed if you plan to generate PDF documents via LaTeX. A simpler alternative is to generate HTML and then ask a browser such as Chrome to save it as PDF, or read the file into Word and then save it as PDF.
1. For best results generating PDF documents we first convert Markdown to LaTeX using Pandoc, and then use a LaTeX-to-PDF converter.
This will be part of a LaTeX installation such as MikTeX on Windows, MacTex on Mac OS X, or TeX Live on Unix. Consult your local TeX guru if you need help installing this tool.
2. You then use the
whereis command to register the location of your converter so
markstat can find it. For example on a Windows computer where I had installed MikTeX 2.9 on a folder of the same name on the
D: drive I used
whereis pdflatex "d:\MiKTeX 2.9\miktex\bin\pdflatex.exe"
using quotes because the file path includes a space. Again, your location may differ.
3. You also need a LaTeX style file called
stata.sty, which is needed to render
Stata output. This file can be downloaded from the Stata Journal using the Stata command
copy http://www.stata-journal.com/production/sjlatex/stata.sty stata.sty
which will copy the file to your current directory. To avoid having multiple copies in various
folders consider copying
stata.sty to your the TeX tree and updating the
TeX database. Please consult the documentation for your LaTeX distribution for instructions.