IDEAS home Printed from https://ideas.repec.org/a/tsj/stataj/v20y2019i2p336-362.html
   My bibliography  Save this article

Software documentation with markdoc 5.0

Author

Listed:
  • E. F. Haghish

    (University of Göttingen)

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.

Suggested Citation

  • E. F. Haghish, 2020. "Software documentation with markdoc 5.0," Stata Journal, StataCorp LP, vol. 20(2), pages 336-362, June.
    • Handle: RePEc:tsj:stataj:v:20:y:2019:i:2:p:336-362
    DOI: 10.1177/1536867X20931000
    as

    Download full text from publisher

    File URL: http://www.stata-journal.com/article.html?article=pr0072
    File Function: link to article purchase
    Download Restriction: no
    File URL: http://www.stata-journal.com/software/sj20-2/pr0072/
    Download Restriction: no
    File URL: https://libkey.io/10.1177/1536867X20931000?utm_source=ideas
    LibKey link: if access is restricted and if your library uses this service, LibKey will redirect you to where you can use your library subscription to access this item
    ---><---

    Citations

    Citations are extracted by the CitEc Project, subscribe to its RSS feed for this item.
    as


    Cited by:

    1. Ben Jann, 2022. "sttex – a new dynamic document command for Stata and LaTeX," London Stata Conference 2022 14, Stata Users Group.

    Corrections

    All material on this site has been provided by the respective publishers and authors. You can help correct errors and omissions. When requesting a correction, please mention this item's handle: RePEc:tsj:stataj:v:20:y:2019:i:2:p:336-362. See general information about how to correct material in RePEc.

    If you have authored this item and are not yet registered with RePEc, we encourage you to do it here. This allows to link your profile to this item. It also allows you to accept potential citations to this item that we are uncertain about.

    We have no bibliographic references for this item. You can help adding them by using this form .

    If you know of missing items citing this one, you can help us creating those links by adding the relevant references in the same way as above, for each refering item. If you are a registered author of this item, you may also want to check the "citations" tab in your RePEc Author Service profile, as there may be some citations waiting for confirmation.

    For technical questions regarding this item, or to correct its authors, title, abstract, bibliographic or download information, contact: Christopher F. Baum or Lisa Gilmore (email available below). General contact details of provider: http://www.stata-journal.com/ .

    Please note that corrections may take a couple of weeks to filter through the various RePEc services.

    IDEAS is a RePEc service. RePEc uses bibliographic data supplied by the respective publishers.