Code blocks appear as (underlined) links #113792
-
Select Topic AreaProduct Feedback BodyFor some reason code blocks in restructuredtext-formatted README.rst files started to appear as underlined links recently:
This can be switched off by changing to "Hide link underlines" in settings > accessibility > content. However imho this is not accessibility question, but an issue with the generation of the respective code block's html, that is not every line should be rendered inside an For reference, the respective code block is valid RST (source). Other README.rst in other repositories have the same issue, e.g. Sphinx, Related IssuesIt appears that this specific issue (code block formatting) has been solved by github. Please report any other RST rendering issues at Possible regression: failed rendering of ReStructuredText files #86715 |
Beta Was this translation helpful? Give feedback.
Replies: 13 comments 15 replies
-
Hello @miraculixx
This way
|
Beta Was this translation helpful? Give feedback.
-
|
That's for Markdown files. This is about reStructuredText (RST) files, where ``` is meaningless. |
Beta Was this translation helpful? Give feedback.
-
|
ooh okay i get it
|
Beta Was this translation helpful? Give feedback.
-
|
Thanks. However my point is it used to work as in my OP, and it still should as afaik it is the official RST syntax for code blocks. |
Beta Was this translation helpful? Give feedback.
-
|
Yeah the RST syntax .. code:: language is collect. I think the issue is the current GitHub RST parser related, |
Beta Was this translation helpful? Give feedback.
-
|
Possibly related: GitHub seems to have issues with RST more generally (e.g. files not rendering at all): https://github.com/orgs/community/discussions/86715 |
Beta Was this translation helpful? Give feedback.
-
|
Indeed, and the problem with the underlines affects a lot of other documents as well. I'm for now happy that the documents which simply stopped rendering at all since beginning of January are rendering again, but having them rendered with proper syntax highlighting instead of underlines would be even better :) |
Beta Was this translation helpful? Give feedback.
-
|
two of my projects also had rendering issues for the README.rst files https://github.com/NeuroJSON/zmat/blob/master/README.rst |
Beta Was this translation helpful? Give feedback.
-
|
Same here: https://github.com/HofstadterTools/HofstadterTools?tab=readme-ov-file#how-to-cite |
Beta Was this translation helpful? Give feedback.
-
|
Also, github has at the same time broken the alignment of my images in the readme.rst: https://github.com/HofstadterTools/HofstadterTools?tab=readme-ov-file#quick-start They should each be 32% width, as correctly rendered by sphinx: https://hofstadter.tools/overview.html#quick-start |
Beta Was this translation helpful? Give feedback.
-
|
my other code blocks, which are not underlined, have lost their syntax highlighting |
Beta Was this translation helpful? Give feedback.
-
|
same https://github.com/BrianPugh/autoregistry/blob/main/README.rst |
Beta Was this translation helpful? Give feedback.
-
|
same https://github.com/dfunckt/django-rules?tab=readme-ov-file#using-rules (no affiliation) |
Beta Was this translation helpful? Give feedback.
-
|
I'll add mine to the piles, all my projects using a README.rst are facing issues:
few problematic repositories:
Strangly enough one of my repo (using the same readme template) is rendering perfectly now: https://github.com/gee-community/geetools |
Beta Was this translation helpful? Give feedback.
-
|
Thanks for this. It appears that some issues have been fixed. Please report remaining issues here https://github.com/orgs/community/discussions/86715 |
Beta Was this translation helpful? Give feedback.
-
|
Just adding my upvote for a fix. I have 6 projects that are affected. |
Beta Was this translation helpful? Give feedback.
-
|
I opened a ticket (No. 2709825) with GitHub support. https://github.com/tqdm/tqdm#readme looks sad now :( Also related to tqdm/tqdm#1546. |
Beta Was this translation helpful? Give feedback.
-
|
Same problem for a long time ... |
Beta Was this translation helpful? Give feedback.
-
|
Not sure if relevant, but on one of my projects it just happened today after I made (unrelated) edits to the |
Beta Was this translation helpful? Give feedback.
-
|
so I am not alone in this issue. |
Beta Was this translation helpful? Give feedback.
-
|
I second this request. RST readme texts are broken in my projects. |
Beta Was this translation helpful? Give feedback.
-
|
Dear fellow Githubians, it seems that the rst Gods have answered our prayers! Today, I can see syntax highlights on my repositories once again! |
Beta Was this translation helpful? Give feedback.
-
|
Fixed for me too! 👍 However, the image formatting is still broken: https://github.com/HofstadterTools/HofstadterTools?tab=readme-ov-file#quick-start I used to have 3 images side-by-side, as correctly rendered by Sphinx: https://hofstadter.tools/overview.html#quick-start |
Beta Was this translation helpful? Give feedback.
-
|
the rest of the issues raised in this thread (images, code block and links) are still very wrong in my repositories as well. |
Beta Was this translation helpful? Give feedback.
-
|
I think it would be best to report all remaining issues here https://github.com/orgs/community/discussions/86715 |
Beta Was this translation helpful? Give feedback.
-
|
It's still problem with tables -- https://github.com/pbelskiy/ujenkins |
Beta Was this translation helpful? Give feedback.
Dear fellow Githubians, it seems that the rst Gods have answered our prayers! Today, I can see syntax highlights on my repositories once again!