Software documentation with markdoc 5.0

被引：1
作者：
Haghish, E. F. [1 ]
机构：
[1] Univ Gottingen, Dept Med Psychol & Med Sociol, Gottingen, Germany
来源：
STATA JOURNAL | 2020年 / 20卷 / 02期
关键词：
pr0072; markdoc; mini; Pandoc; statistics software; software documentation; literate programming; social coding;
D O I：
10.1177/1536867X20931000
中图分类号：
O1 [数学]; C [社会科学总论];
学科分类号：
03 ; 0303 ; 0701 ; 070101 ;
摘要：
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.
引用
收藏
页码：336 / 362
页数：27
相关论文
共 30 条
[1]  
[Anonymous], GITHUB MODULE BUILDI
[2]  
Baum C. F., 2011, SUBMITTING RETRIEVIN
[3]   Software documentation: How much is enough? [J].
Briand, LC .
SEVENTH EUROPEAN CONFERENCE ON SOFTWARE MAINTENANCE AND REENGINEERING, PROCEEDINGS, 2003, :13-15
[4]  
Brown P. J., 1974, Computing Surveys, V6, P213, DOI 10.1145/356635.356637
[5]   THE LITERATE-PROGRAMMING PARADIGM [J].
CORDES, D ;
BROWN, M .
COMPUTER, 1991, 24 (06) :52-61
[6]  
de Souza Sergio Cozzetti B., 2005, P 23 ANN INT C DES C, P68, DOI 10.1145/1085313.1085331
[7]  
Gruber John, 2004, MARKDOWN SYNTAX
[8]   On the importance of syntax coloring for teaching statistics [J].
Haghish, E. F. .
STATA JOURNAL, 2019, 19 (01) :83-86
[9]   Rethinking literate programming in statistics [J].
Haghish, E. F. .
STATA JOURNAL, 2016, 16 (04) :938-963
[10]   markdoc: Literate programming in Stata [J].
Haghish, E. F. .
STATA JOURNAL, 2016, 16 (04) :964-988
123