Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rendering backticks with trailing s not closing monospace block #212

Open
MarijnS95 opened this issue Apr 3, 2023 · 2 comments
Open

Rendering backticks with trailing s not closing monospace block #212

MarijnS95 opened this issue Apr 3, 2023 · 2 comments
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@MarijnS95
Copy link

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

@oddhack
Copy link
Contributor

oddhack commented Apr 3, 2023

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 oddhack transferred this issue from KhronosGroup/Vulkan-Site Apr 3, 2023
@oddhack oddhack added bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers labels Apr 3, 2023
@MarijnS95
Copy link
Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants