Vulkan-Guide icon indicating copy to clipboard operation
Vulkan-Guide copied to clipboard

Rendering backticks with trailing `s` not closing monospace block

Open MarijnS95 opened this issue 2 years ago • 2 comments

Looks like the new site renderer (as does GH's adoc renderer) has trouble with things like plural references, `VkImageView`s in the example. This works just fine in GitHub where the monospace is properly closed before s: VkImageViews - but not on the new site nor when GH renders the adoc:

image

https://registry.khronos.org/vulkan/site/guide/latest/extensions/VK_KHR_imageless_framebuffer.html https://github.com/KhronosGroup/Vulkan-Guide/blob/main/chapters/extensions/VK_KHR_imageless_framebuffer.adoc

MarijnS95 avatar Apr 03 '23 11:04 MarijnS95

I think this should be raised as a fix to the Guide markup, per the asciidoc site:

As with other types of text formatting, if the text is bounded by word characters on either side, it must be enclosed in a double pair of backtick characters (``) in order for the formatting to be applied.

I'm not sure of the difference between "works fine in GitHub... but not when GH renders the adoc", but Antora is using a recent asciidoctor implementation that behaves as documented.

I think this is literally the only place this particular usage exists in the repository, though.

oddhack avatar Apr 03 '23 13:04 oddhack

Oh, I wasn't aware of the double-backticks to allow this, thanks! Indeed GH in messages is using a different renderer.

MarijnS95 avatar Apr 04 '23 14:04 MarijnS95