Software documentation with markdoc 5.0

E. F. Haghish ()
Additional contact information
E. F. Haghish: University of Göttingen

Stata Journal, 2020, vol. 20, issue 2, 336-362

Abstract: markdoc is a general-purpose literate programming package for generating dynamic documents, dynamic presentation slides, Stata help files, and package vignettes in various formats. In this article, I introduce markdoc ver- sion 5.0, which performs independently of any third-party software, using the mini engine. The mini engine is a lightweight alternative to Pandoc (MacFarlane [2006, https://pandoc.org/]), completely written in Stata. I also propose a proce- dure for remodeling package documentation and data documentation in Stata and present a tutorial for generating help files, package vignettes, and GitHub Wiki documentation using markdoc. Copyright 2020 by StataCorp LP.

Keywords: markdoc; mini; Pandoc; statistics software; software documentation; literate programming; social coding (search for similar items in EconPapers)
Date: 2020
References: Add references at CitEc
Citations: View citations in EconPapers (2)

Downloads: (external link)
http://www.stata-journal.com/article.html?article=pr0072 link to article purchase
http://www.stata-journal.com/software/sj20-2/pr0072/ (text/html)

Related works:
This item may be available elsewhere in EconPapers: Search for items with the same title.

Export reference: BibTeX RIS (EndNote, ProCite, RefMan) HTML/Text

Persistent link: https://EconPapers.repec.org/RePEc:tsj:stataj:v:20:y:2019:i:2:p:336-362

Ordering information: This journal article can be ordered from
http://www.stata-journal.com/subscription.html

DOI: 10.1177/1536867X20931000

Access Statistics for this article

Stata Journal is currently edited by Nicholas J. Cox and Stephen P. Jenkins

More articles in Stata Journal from StataCorp LLC
Bibliographic data for series maintained by Christopher F. Baum () and Lisa Gilmore ().