mini

The mini argument is meant to make MarkDoc package easier to use on computers that have restrictions with running binaries downloaded from the web.

The mini mode requires Stata 15 or higher. Other users who wish to generate dynamic documents with MarkDoc on lower versions of Stata can still use the package with the installed binaries (read the manuscript published at Stata Journal)

MarkDoc Mini GUI

To make working in Mini mode easier, I created a GUI that can be executed by typing:

db mini

What can you do in Mini mode?

Pretty much all you could do with the help of Pandoc and wkhtmltopdf. The mini mode assumes that you have written your documentation with Markdown. If so, it allows you to create a document in the following formats:

• md (plain text Markdown)
• html document along with all features that were supported before (Complete Syntax highlighter, document layout, etc)
• docx document along with basic syntax highlighter, separating Stata commands from output results
• pdf document along with basic syntax highlighter, separating Stata commands from output results
• sthlp which is the Stata Help file format. Programmers can make use of MarkDoc to write their program documentation with Markdown and export sthlp help files within MarkDoc package

However the Stata 15 features yet do not allow taking full benefit of Markdown syntax. Therefore, some of the features are not yet supported. See the table below to see which Markdown syntax is supported in the minimode.

Supported Markdown Syntax

• Markdown Headers
• paragraph indention and nested intentions
• Markdown basic text styles (bold, italic, bold & italic, monospace font, hyperlink, line break)
• ordered and un-ordered lists are supported
• code lines with 4 spaces are supported
• code blocks using ~~~ syntax are supported
• adding dynamic text with the txt command is fully supported
• adding an image with Markdown syntax is supported. The img command is fully supported
• adding a dynamic table with the tbl command is fully supported

The followings are NOT YET SUPPORTED

1. Stata 15 does not support hyperlink in putdocx and putpdf commands... However hyperlinks are supported in sthlp format
2. nested lists (2 level or more) are not yet supported because putdocx and putpdf in Stata 15 are not supporting nested lists.
3. putdocx and putpdf do not support horizontal line syntax
4. putdocx and putpdf do not support Mathematical notations
5. General Markdown tables are not supported yet. Only Markdown tables generated by the tbl command are recognized. this is were your help is needed! fork the repository and help improving this feature!