mkdoc - 0.11.3

This is a bugfix release in comparison to 0.11.0 which was mainly targeting compatibility with Tcl 9:

0.11.3 contains the following bug-fixes:

• 2025-01-04 Version 0.11.1
  • fixing outfile ending with Tmd, Rmd etc seen as HTML files
• 2025-01-18 Version 0.11.2
  • fixing inline multiple images on the same line
• 2025-01-27 Release 0.11.3
  - fixing wrong command line argument crash
  - fixing uneven length option list

Note: That package/application will be soon renamed to mndoc to avoid confusions with the mkdoc package in Tcllib. I need to develop that tool at a different pace than the package in Tcllib can accomplish to include new features in pantcl and pantcl4r

mkdoc 0.11.0

Markdown to HTML converter and source code documentation tool using embedded Markdown for programming languages supporting either multiline comments or at least the # character for comments.

• Tcl application for document conversion from Markdown to HTML
• Tcl application to extract Markdown documentation from source code tools
• Tcl library for programmers to accomplish both things above from within the Tcl programming language

This release should be Tcl 9 aware.

mkdoc 0.10.2

Markdown to HTML converter and source code documentation tool using embedded Markdown for programming languages supporting either multiline comments or at least the # character for comments.

Tcl application for document conversion from Markdown to HTML
Tcl application to extract Markdown documentation from source code tools
Tcl library for programmers to accomplish both things above from within the Tcl programming language

This release fixes and ampersand issue on source code.

mkdoc 0.10.0

NEWS

This release adds support for inline images and css code for local files as well as adds a refresh option to for debugging and developing purposes reloading the HTML page every N seconds.

INSTALLATION

On Linux, MacOS and on Windows with installed Msys2 or Cyvwin download the latest mkdoc-VERSION.bin binary (90kb in size), rename it to mkdoc and copy the file to a folder belonging to your PATH variable. Thereafter make the file executable and check that it is correctly installed like this:

$ mkdoc --version
0.10.0

MathJax support

This release adds MathJax support.

Add your equations either inline using the \\( inline equation \\) syntax or as a block using the \\[ block equation \tag{N} \\] syntax.

Documents must be then processed using the --mathjax true argument

The file mkdoc-0.9.0 bin is a Tcl script which contains the Tcl code and all required Tcl libaries. Jus tmake this file executable and copy it as mkdoc to a folder belonging to your PATH.

Javascript Highlighting Support and Image Fix

This release is ahead of the Tcllib release. It contains the following fixes and additions.

• fix for image tag
• adding header and footer support
• adding javascript (single and multiple file support)
• adding code highlight support
• adding css support for multiple files
• fix for library Markdown bugs in handling of code fences
• adding standalone binary mkdoc.bin, see below

To use the binary as application, just download the file mkdoc-0.8.0 (<100kb), make it executable, rename it to mkdoc and copy it to a folder belonging to your PATH. The file contains all required Tcl libraries (fixed markdown, yaml, cmdline, textutil) so that for running the program just a recent Tcl interpreter (8.5+) is needed.