runzmd VS goldmark

I put together a library in Golang, called runzmd which lets you use Markdown in a literate programming style. Blockquotes and comments can specify associated actions, calling back into your Go code. This lets you create tutorials and scripts which can be viewed in a browser or run on the command line. We use this in the OpenZiti project for our tutorials and demos. I thought others might be interested in using the code or even just the concept.

The only place I've used it so far is for Ziti stuff. I did add a (really tiny) example to the project itself to show how to structure it: https://github.com/openziti/runzmd/tree/main/example

That was one reason I left the ziti actions in the project, as I thought they'd be useful as real life examples for someone writing their own actions.

Goldmark used by Hugo.

Yuin/Goldmark is the new standard Go Markdown processor. Black Friday is older.

As for Hugo with its built-in goldmark Markdown parser and included Footnote extension, a footnote’s HTML begins like this (here, it’s the first footnote in a page):

I am writing a library to convert markdown to HTML. In Go, the common library is https://github.com/yuin/goldmark.

Hugo -> goldmark -> goldmark-highlighting -> chroma

Primarily born out of the annoyance of never-ending README copy & paste, our teammate Adam Babik decided to utilize a Markdown Abstract Syntax Tree parser to generate a naive digest of README snippets and make them easily runnable. This is a prototype (take the happy path!), but we are pleased with the initial results. Illustrated here using Husky - a popular solution to manage git hooks:

Building table in markdown is super easy and well-documented. However, having a bit of formatting within it, like carriage return within a cell as below is not possible by default. Hugo uses Goldmark (a CommonMark implementation in Go) to process the markdown. Apparently it's extremely fast, with this implementation we choose to block any HTML processing d'HTML by default.

Comparison: By default, Eleventy uses Markdown-it; like Astro, Gatsby and Next.js use Remark; and Hugo uses goldmark. As for Astro’s ability to mix components and Markdown on a page, probably the closest analogy to this is the use of MDX files in Gatsby and Next.js; Eleventy and Hugo can’t do this (however, see also “Components,” below, for some words on how Eleventy and Hugo use shortcodes which can provide some degree of code-in-Markdown functionality). Note that migrating an existing site to Astro from any of these other platforms probably will involve far more editing to your existing Markdown content than if you were migrating between two of the non-Astro platforms in this mix.

3rd party libraries: goldmark for converting MD syntax to HTML

The solution to the problem of having to escape many characters in LaTeX markup is solved in a simlar manner, however a combination of Hugo now using the Goldmark renderer and the MathJax API changing quite significantly at version 3.0, it largely needs re-writing. Firstly the script to add the class to the code blocks now looks like this: