mndoc

NAME

mndoc::mndoc is a Markdown to HTML converter and can extract Markdown documentation from source code files written in programming languages like Tcl, Python, R, C++, ... and optionally convert them to HTML.

DESCRIPTION

This an extended version of the mkdoc::mkdoc tool which is part of tcllib. It offers the following extensions in comparison to mkdoc:

• stand-alone simplified installation using shell script file size for install less than 150kb
• support for syntax highlighting using Javascript highlighters
• support for embedded LaTeX equations using Mathjax
• header, footer support
• base64 encoding of local images, cascading style sheets and Javascript files for creating stand-alone HTML files during conversion from Markdown or in already existing HTML files
• support for image attributes like width
• support for styling via YAML header
• omission of HTML header and footer if requested
• refresh HTML option for development

LINKS

• Author: Detlef Groth
• Homepage: https://github.com/mittelmark/mndoc
• Documentation (HTML): https://htmlpreview.github.io/?https://github.com/mittelmark/mndoc/blob/master/mndoc/mndoc.html
• Documentation (PDF): https://github.com/mittelmark/mndoc/releases/latest/download/mndoc.pdf
• Version: 0.14.1
• License: BSD

SEE ALSO

• tmdoc::tmdoc - partner application of *mndoc* for literature programming

DISCUSSION

DDG - 2025-10-23 - Why this fork? I needed more, may be unstable, features and less embedding into the Tcllib structure.

DDG - 2025-10-26 v0.14.1 fixes an cache file right issues if multiple users use the application on the same machine