Skip to content

Latest commit

 

History

History
86 lines (47 loc) · 5.24 KB

index.md

File metadata and controls

86 lines (47 loc) · 5.24 KB

MarkDoc : a general-purpose literate programming package for Stata

MarkDoc is a general-purpose literate programming package for Stata. MarkDoc is very simple and intuitive to use, yet a powerful software for creating dynamic documents interactively in a variety of formats such as sthlp, pdf, docx, tex, html, odt, epub, and markdown. The software has a considerable focus on making literate programming easy-to-learn and practice for newbies. Therefore, it can be taught to undergraduate students in introductory courses to document code and practice statistical reporting. Continue to MarkDoc documentation...

Resources

Manual

MarkDoc package vignette (PDF)

Journal Article

Examples

Torture tests

Need help? Ask your questions on statalist.org

Need more help? Contact the author to plan a workshop in your department or company

Installation

MarkDoc requires a few other Stata packages. The github package can be used to install MarkDoc and all of its dependencies as shown below. Using github package is highly recommended.

github install haghish/markdoc

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

The pdfLaTeX is optional, but required for generating PDF slides and typesetting documents written in LaTeX. The wkhtmltopdf is only required for generating PDF documents from Markdown. MarkDoc provides optional automatic installation of pandoc and wkhtmltopdf if the install argument is specified. You can read more about the installation in the manual...

Dialog box

To further facilitate using MarkDoc for beginners, a dialog box was written for Stata, which covers all features and most of the important options of MarkDoc. The dialog box supports all three engines of MarkDoc for creating dynamic document, dynamic presentation slides, and package vignette (e.g. Stata help files, package manual, etc).

To use the dialog box, type:

db markdoc

The dialog box is documented in details in the manual. Stata users that are new to MarkDoc are encouraged to have a look at the dialog box to get an idea of what they can do with MarkDoc.

Built-in syntax highlighter

Wish to develop handouts or presentation slides within Stata? MarkDoc has a built-in syntax highlighter for Stata code in HTML, LaTeX, and PDF formats, including presentation slides! You can also add the syntax highlighter to your blog! Read how...

Much effort was put to develop a syntax highlighter for Stata, which was not available before. This just shows how caring MarkDoc is, when it comes to teaching statistics! MarkDoc was intended to be used in daily routine, as early as introductory statistics courses to help students document their code and read it with more care.

Author

E. F. Haghish, Ph.D.
Department of Medical Psychology and Medical Sociology,
University of Göttingen, Germany

http://www.haghish.com/contact.php
@Haghish