starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Single Linebreak in Markdown should lead to Linebreak in Output #9337

New Issue
Closed
opened 2025-12-29 20:48:42 +01:00 by adam · 3 comments
adam commented 2025-12-29 20:48:42 +01:00
Owner
Copy Link

Originally created by @xeiss on GitHub (Mar 8, 2024).

Deployment Type

Self-hosted

NetBox Version

v3.7.3

Python Version

3.9

Steps to Reproduce

  1. Create any object with a Markdown field, for example an device with Comments field.
  2. Write Text with one line break into it, for example: "Text 1(ENTER)Text 2", that it looks like:
    Text 1
    Text 2
  3. Click on Preview (or save and look at the object)

Expected Behavior

One line break should lead to an
in html and so it should in preview look like:
Text 1
Text 2

HTML:

<div class="rendered-markdown"><p>Text 1
<br>
Text 2</p></div>

I should behavior like it is documented in https://docs.netbox.dev/en/stable/reference/markdown/ - at the bottom you find "Line Breaks" example, you can see a line break after "but..." and so also in the output text.

Observed Behavior

In preview the example text look like:
Text 1 Text 2

HTML:

<div class="rendered-markdown"><p>Text 1 
Text 2</p></div>
Originally created by @xeiss on GitHub (Mar 8, 2024). ### Deployment Type Self-hosted ### NetBox Version v3.7.3 ### Python Version 3.9 ### Steps to Reproduce 1. Create any object with a Markdown field, for example an device with Comments field. 2. Write Text with one line break into it, for example: "Text 1(ENTER)Text 2", that it looks like: Text 1 Text 2 3. Click on Preview (or save and look at the object) ### Expected Behavior One line break should lead to an <br> in html and so it should in preview look like: Text 1 Text 2 HTML: ``` <div class="rendered-markdown"><p>Text 1 <br> Text 2</p></div> ``` I should behavior like it is documented in https://docs.netbox.dev/en/stable/reference/markdown/ - at the bottom you find "Line Breaks" example, you can see a line break after "but..." and so also in the output text. ### Observed Behavior In preview the example text look like: Text 1 Text 2 HTML: ``` <div class="rendered-markdown"><p>Text 1 Text 2</p></div> ```
adam closed this issue 2025-12-29 20:48:42 +01:00
adam commented 2025-12-29 20:48:43 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Mar 8, 2024):

NetBox renders Markdown in conformance with its specification, which asserts:

When you do want to insert a <br /> break tag using Markdown, you end a line with two or more spaces, then type return.

This is how the documentation example you reference is written.

@jeremystretch commented on GitHub (Mar 8, 2024): NetBox renders Markdown in conformance with its [specification](https://daringfireball.net/projects/markdown/syntax#p), which asserts: > When you _do_ want to insert a `<br />` break tag using Markdown, you end a line with two or more spaces, then type return. This is how the documentation example you reference is written.
adam commented 2025-12-29 20:48:43 +01:00
Author
Owner
Copy Link

@xeiss commented on GitHub (Mar 9, 2024):

Okay, I don’t know about this official specs because every Markdown I know ignores this and accept line breaks without double spaces. Also, Github itself seems to ignore this, because it is more natural, I think.

But in this case the documentation is wrong. https://docs.netbox.dev/en/stable/reference/markdown/
When there would be double spaces after "but ..." in the bottom example code. I would copy that and find out, that I need double spaces by my own. But also, this example doesn't work that is why I thought it is a bug and raised this issue.

@xeiss commented on GitHub (Mar 9, 2024): Okay, I don’t know about this official specs because every Markdown I know ignores this and accept line breaks without double spaces. Also, Github itself seems to ignore this, because it is more natural, I think. But in this case the documentation is wrong. https://docs.netbox.dev/en/stable/reference/markdown/ When there would be double spaces after "but ..." in the bottom example code. I would copy that and find out, that I need double spaces by my own. But also, this example doesn't work that is why I thought it is a bug and raised this issue.
adam commented 2025-12-29 20:48:44 +01:00
Author
Owner
Copy Link

@jeffgdotorg commented on GitHub (Mar 10, 2024):

But in this case the documentation is wrong.

Please open a new issue against the docs and we'll consider it separately. Thanks.

@jeffgdotorg commented on GitHub (Mar 10, 2024): > But in this case the documentation is wrong. Please open a new issue against the docs and we'll consider it separately. Thanks.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#9337
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?