Skip to content

Installation

E. F. Haghish edited this page Sep 29, 2018 · 11 revisions

MarkDoc package can ONLY be installed from Github and is not hosted on SSC any longer. The Stata github package can be used to install MarkDoc or any other Stata package hosted on Github. If you don't have the github command installed, type:

net install github, from("https://haghish.github.io/github/")

Next, to install MarkDoc along with its dependencies from GitHub, type:

github install haghish/markdoc

The command above installs MarkDoc and its dependencies (other Stata packages), which are Weaver, Statax, and md2smcl (see the dependency.do file in the Github repository which is executed after installing MarkDoc).

Required third-party software

MarkDoc also requires 3 third-party software, which are:

Having Pandoc installed on your system is rather necessary because many features of MarkDoc rely on Pandoc. The pdfLaTeX is optional, but required for generating PDF slides and typesetting documents written in LaTeX. If you write your document using Markdown and do not intend to generate dynamic PDF slides within Stata, you don't need to install pdfLaTeX. The wkhtmltopdf is only required for generating PDF documents from Markdown. Luckily, Pandoc and wkhtmltopdf can be installed automatically (see below).

Automatic installation

MarkDoc provides optional automatic installation of pandoc and wkhtmltopdf if the install argument is specified.

Manual installation

Users can also download and install these software manually and define the paths to executable software in MarkDoc. For example, if you wish to create a dynamic document

The users can also permanently define the paths to these software using the weave setup command which memorizes the paths to the executable Pandoc and wkhtmltopdf permanently, even if MarkDoc package gets updated. The path information is stored in an ado file named weaversetup.ado, which can be found in /PLUS/w/weaversetup.ado.