Markdown table is broken in the Custom Links doc page #5531

Closed
opened 2025-12-29 19:29:03 +01:00 by adam · 1 comment
Owner

Originally created by @HumanEquivalentUnit on GitHub (Oct 19, 2021).

Originally assigned to: @jeremystretch on GitHub.

Change Type

Cleanup (formatting, typos, etc.)

Area

Functionality/features

Proposed Changes

Following #7367 I checked the live custom links page at ReadTheDocs.io to see if my change got through (exciting!) and noticed that the markdown table in the Context Data section is not rendering properly. I don't think it's my machine - tried two browsers - but just in case, this is what I see:


markdown table showing as ASCII characters

It is rendering properly in the page preview here on GitHub


markdown table showing as a table

I can't see that I made any changes to that section in my pull request, and can't see what's wrong with the source.
(Not sure if this needs its own issue, but doesn't seem right to reopen the other one)

Originally created by @HumanEquivalentUnit on GitHub (Oct 19, 2021). Originally assigned to: @jeremystretch on GitHub. ### Change Type Cleanup (formatting, typos, etc.) ### Area Functionality/features ### Proposed Changes Following #7367 I checked the [live custom links page at ReadTheDocs.io](https://netbox.readthedocs.io/en/stable/customization/custom-links/) to see if my change got through (exciting!) and noticed that the markdown table in the **Context Data** section is not rendering properly. I don't think it's my machine - tried two browsers - but just in case, this is what I see: ---- ![markdown table showing as ASCII characters](https://user-images.githubusercontent.com/187787/137832662-ac2083b7-e895-45f9-8edf-b508925c56ef.png) ---- It is rendering properly [in the page preview here on GitHub](https://github.com/netbox-community/netbox/blob/develop/docs/models/extras/customlink.md) ---- ![markdown table showing as a table](https://user-images.githubusercontent.com/187787/137836148-8293305a-f8e5-4742-bcc6-873de4ad85a8.png) ---- I can't see that I made any changes to that section in my pull request, and can't see what's wrong with the source. (Not sure if this needs its own issue, but doesn't seem right to reopen the other one)
adam added the status: acceptedtype: documentation labels 2025-12-29 19:29:03 +01:00
adam closed this issue 2025-12-29 19:29:03 +01:00
Author
Owner

@jeremystretch commented on GitHub (Oct 19, 2021):

The root issue here is that tables within included pages don't get rendered, unfortunately. But we can work around this specific instance by just referencing customlink.md directly within the navigation menu.

@jeremystretch commented on GitHub (Oct 19, 2021): The root issue here is that tables within included pages don't get rendered, unfortunately. But we can work around this specific instance by just referencing `customlink.md` directly within the navigation menu.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#5531