[DOCS]: riverqueue.com: poorly rendered <code> snippets.

[neilotoole]

Howdy lads,

I just came across your project, I really like what you're building. I'm going to give it a try shortly.

One minor nitpick: the code block rendering on the docs site renders the markdown backtick. I presume this is accidental? If intentional... I don't think it works. E.g. these two particularly egregious tickfests:

From: https://riverqueue.com/docs/batch-job-insertion

Keep up the good work, looking forward to trying it out.

[bgentry]

Thanks @neilotoole, this has been bugging me since I set up the site and your comment reminded me to take care of it. Should be all good now ✨

[neilotoole]

this has been bugging me

@bgentry I would have been deeply disappointed if this critical issue hadn't been bugging you! 😜

While you're in there... on the same page, I suspect you're missing the code fence on two links:

In the interest of not consuming all your time: I imagine you're using some sort of static site generator like Hugo, backed by a GH repo? Have you considered making that repo public so PRs can be submitted?

For the docs site for my main side project, sq, I enabled some Hugo setting, and it shows an Edit this page on GitHub link. E.g. if you scroll to the bottom of this page, you'll see a link:

[brandur]

FYI, the visible backticks come from Tailwind's typography plugin. It's a stylistic thing for sure, but I don't know, I think they look good.

https://tailwindcss.com/docs/typography-plugin

While you're in there... on the same page, I suspect you're missing the code fence on two links:

Fixed those two.

For the docs site for my main side project, sq, I enabled some Hugo setting, and it shows an Edit this page on GitHub link. E.g. if you scroll to the bottom of this page, you'll see a link:

Yeah, we might want to do that eventually. The docs repo is still in somewhat rough shape though, so we probably wouldn't make it public without an overhaul.

[neilotoole]

but I don't know, I think they look good.

I was in two minds about the ticks when I first saw them on the site, but whether or not the look has appeal, this...

... is not a good outcome.

The docs repo is still in somewhat rough shape though, so we probably wouldn't make it public without an overhaul.

Roger that. I think it looks very solid overall fwiw 👍