hugo-site VS goldmark

This month, I took my site squarely into npm-ville when I brought in the npm version of Sass and added PostCSS to make "future" CSS work with current browsers. As it turns out, those changes made my site an unexpectedly appropriate target for the use case that Hugo Installer presents. I’m sure I’ll find nits to pick over time but, for now, I’m impressed by what I’ve seen.

Fortunately, while there are limits to how much you’ll be able to improve your experience with online search in general, you can optimize your own website’s search capabilities. That’s assuming, of course, that your website is built with a static site generator (SSG), as I’ve recommended on my own website over the years, and has search capabilities in the first place. If it lacks search, you can fix that readily enough with the free Pagefind tool about which I wrote earlier this year.

In Line 2 of the partial that I use for the search bar and results, I comment out the line of code that calls to the Pagefind CSS. (I derived it from the Pagefind documentation.) It's this step for which I can't find the corresponding code in your repo, but I'm sure you know where it is; and that's the key to this.

(a.) My own site, https://www.brycewray.com --- currently hosted on Cloudflare Pages, although it's also been on other Jamstack hosts such as Netlify, Vercel, and (briefly) Render.

although I (b.) also sometimes put stuff on dev.to.

Thanks! I will at some point. The code — in its current, very “as-is” state — is in my repo at (as of now) https://github.com/brycewray/hugo_site/blob/main/layouts/partials/webmentions-pipes.html if you can bear its spaghetti-ness. But, assuming you mean you’ll want a walk-through explanation: yes, that’s yet to come. There are some things I need to refine, first.

When I have the code somewhat DRY-er, I’ll write about it. In the meantime, I’ve left the following comment within the webmentions-pipes partial template I’m using to suck all this into each applicable post, just in case the curious happen to find that partial on the site repo:

By Bryce Wray

Having just moved my own site to Astro yesterday after a week or two of experimentation and grunt work, I can offer some opinions which may help you with that question. I’ll go through the “boxes” which I believe any SSG or other website development platform should “check” before you should give it a shot at this task, along with how I judge Astro’s ability to do so in each case.

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: