goldmark VS chroma

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:

In Hugo and its built-in Chroma syntax highlighting, a code block begins with:

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

I've used a markdown to html converter to convert my blog posts into HTML with very nice and customizable code samples... in my case I used Go's Blackfriday library with bfchroma[1] doing syntax highlighting with Chroma[2]. To add your language to Chroma you have to provide a lexer, which in turn is written in Pygments[3] syntax.

[1] https://github.com/Depado/bfchroma/

[2] https://github.com/alecthomas/chroma#supported-languages

[3] https://pygments.org/docs/lexerdevelopment/

quick for generating Html and syntax highlighting code blocks

Chroma

For books from other publishers, I am just hardcoding language directly on an ad hoc basis. I briefly considered off-loading language detection to a library like chroma, but that might be too much work for little benefit.

Great blog, you should definitely do research on how you could implement a syntax highlighter for the code parts. Go Hugo for example, uses Chroma. Nice work 👍