Software documentation with markdoc 5.0

• Autores: E. F. Haghish
• Localización: The Stata journal, ISSN 1536-867X, Vol. 20, Nº. 2, 2020, págs. 336-362
• Idioma: inglés
• Texto completo no disponible (Saber más ...)
• Resumen

  • 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 version 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 procedure 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.