Markdown parser should respect single newlines #5273

New Issue

GiteaMirror · 2025-11-02T06:19:56-06:00

GiteaMirror commented

2025-11-02 06:19:56 -06:00

Originally created by @silverwind on GitHub (Apr 20, 2020).

Given markdown

a
b

GitHub renders two lines because of  :

<p>a<br>
b</p>

Gitea renders one line because \n is converted to according to HMTL whitespace rules:

<p>a
b</p>

Might be a divergation from the spec in GFM, but it'd be more intuitive if we'd insert those   and trim the newline off the . Alternatively, adding white-space: pre on the  in CSS would also work but may have more unintended side effects.

Originally created by @silverwind on GitHub (Apr 20, 2020). Given markdown ```md a b ``` GitHub renders two lines because of ` `: ```html a b ``` Gitea renders one line because `\n` is converted to ` ` according to HMTL whitespace rules: ```html a b ``` Might be a divergation from the spec in GFM, but it'd be more intuitive if we'd insert those ` ` and trim the newline off the ``. Alternatively, adding `white-space: pre` on the `` in CSS would also work but may have more unintended side effects.

GiteaMirror added the topic/ui label 2025-11-02 06:19:56 -06:00

GiteaMirror closed this issue

2025-11-02 06:19:56 -06:00

GiteaMirror commented

2025-11-02 06:19:57 -06:00

@zeripath commented on GitHub (Apr 20, 2020):

@yuin what do you think about this? Is this an expected GFM diversion from the spec?

@zeripath commented on GitHub (Apr 20, 2020): @yuin what do you think about this? Is this an expected GFM diversion from the spec?

GiteaMirror commented

2025-11-02 06:19:57 -06:00

@silverwind commented on GitHub (Apr 20, 2020):

Relevant section of GFM:

https://github.github.com/gfm/#soft-line-breaks

Specifically this seems to be in use:

A renderer may also provide an option to render soft line breaks as hard line breaks.

@silverwind commented on GitHub (Apr 20, 2020): Relevant section of GFM: https://github.github.com/gfm/#soft-line-breaks Specifically this seems to be in use: > A renderer may also provide an option to render soft line breaks as hard line breaks.

GiteaMirror commented

2025-11-02 06:19:57 -06:00

@silverwind commented on GitHub (Apr 20, 2020):

Goldmark already has option WithHardWraps which makes the rendering match GitHub.

@silverwind commented on GitHub (Apr 20, 2020): Goldmark already has [option `WithHardWraps`](https://github.com/yuin/goldmark#html-renderer-options) which makes the rendering match GitHub.

GiteaMirror commented

2025-11-02 06:19:57 -06:00

@silverwind commented on GitHub (Apr 20, 2020):

Further investigation reveals we already have option markdown.ENABLE_HARD_LINE_BREAK that maps to WithHardWraps but it defaults to false. I think we should flip that default.

@silverwind commented on GitHub (Apr 20, 2020): Further investigation reveals we already have option `markdown.ENABLE_HARD_LINE_BREAK` that maps to `WithHardWraps` but it defaults to `false`. I think we should flip that default.

GiteaMirror commented

2025-11-02 06:19:58 -06:00

@zeripath commented on GitHub (Apr 20, 2020):

ah yeah now I recall. I bet this was because of some blackfriday default. I suspect our unit tests expect not HardWraps.

@zeripath commented on GitHub (Apr 20, 2020): ah yeah now I recall. I bet this was because of some blackfriday default. I suspect our unit tests expect not HardWraps.

GiteaMirror commented

2025-11-02 06:19:58 -06:00

@silverwind commented on GitHub (Apr 20, 2020):

Will follow up with a PR that changes the default and improve the documentation around that option.

@silverwind commented on GitHub (Apr 20, 2020): Will follow up with a PR that changes the default and improve the documentation around that option.

GiteaMirror commented

2025-11-02 06:19:59 -06:00

@a1012112796 commented on GitHub (Apr 20, 2020):

Hello, I don't think it's a wrong thing, Because in markdown usually format rulers, we should have more than two spaces after words, or mardwon won't regard it as a new line:
view:

Do you think so? Thanks.

@a1012112796 commented on GitHub (Apr 20, 2020): Hello, I don't think it's a wrong thing, Because in markdown usually format rulers, we should have more than two spaces after words, or mardwon won't regard it as a new line: view: <img width="254" alt="jm1" src="https://user-images.githubusercontent.com/25342410/79775056-3eb25980-8366-11ea-9237-ba7d32d709e7.png"> <img width="218" alt="jm2" src="https://user-images.githubusercontent.com/25342410/79775070-45d96780-8366-11ea-9522-ce1b51146957.png"> Do you think so? Thanks.

GiteaMirror commented

2025-11-02 06:19:59 -06:00

@silverwind commented on GitHub (Apr 20, 2020):

The trailing whitespace "trick" is needed for the original Markdown version but in GFM and CommonMark soft-breaks can optionally be treated as hard-breaks and this is what I'm proposing to default to because it seems the most intuitive.

@silverwind commented on GitHub (Apr 20, 2020): The trailing whitespace "trick" is needed for the original Markdown version but in GFM and CommonMark soft-breaks can optionally be treated as hard-breaks and this is what I'm proposing to default to because it seems the most intuitive.

GiteaMirror commented

2025-11-02 06:19:59 -06:00

@yuin commented on GitHub (Apr 21, 2020):

@zeripath As @silverwind mentioned, GFM defines rendering soft line breaks as hard line breaks as an optional functionality. goldmark has the WithHardWraps option. goldmark users will have the decision on which turning it on.

@yuin commented on GitHub (Apr 21, 2020): @zeripath As @silverwind mentioned, GFM defines rendering soft line breaks as hard line breaks as an **optional** functionality. goldmark has the WithHardWraps option. goldmark users will have the decision on which turning it on.

GiteaMirror referenced this issue

2025-11-02 15:23:36 -06:00

[PR #5273] [MERGED] Add zeripath to maintainers #17733

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github-starred/gitea#5273