镜像站点 · 本页由第三方 GitHub 只读镜像提供,非 GitHub 官方站点,不接受任何登录或凭据输入。前往 github.com
Skip to content

[docs] Update comment about GitHub breaks - #1620

Merged
styfle merged 3 commits into
markedjs:masterfrom
julien-c:patch-1
Mar 19, 2020
Merged

styfle merged 3 commits into
markedjs:masterfrom
julien-c:patch-1

Conversation

@julien-c

Copy link
Copy Markdown
Contributor

GitHub does not, in fact, appear to break on a single line.

GitHub does not, in fact, appear to break on a single line.
@vercel

vercel Bot commented Mar 17, 2020 •

Copy link
Copy Markdown

This pull request is being automatically deployed with ZEIT Now (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://zeit.co/markedjs/markedjs/5z6k4mrtb
✅ Preview: https://markedjs-git-fork-julien-c-patch-1.markedjs.now.sh

@UziTech

UziTech commented Mar 17, 2020 •

Copy link
Copy Markdown
Member

these lines are separated
by a single new line (\n)

GitHub does break on a single new line.

If you view the source for the two lines above you will see a <br> between them instead of being two paragraphs.

image

@UziTech

UziTech commented Mar 17, 2020

Copy link
Copy Markdown
Member

Can you provide an example of when GitHub does not break on a single new line character?

@julien-c

Copy link
Copy Markdown
Contributor Author

Ah, interesting, this seems to be specific to comments. GitHub does not break on a single \n in (at least):

Comment thread docs/USING_ADVANCED.md Resolved
Co-Authored-By: Steven <steven@ceriously.com>
Comment thread docs/USING_ADVANCED.md Resolved
@julien-c

Copy link
Copy Markdown
Contributor Author

Thanks for the suggestion @UziTech @styfle, I reworded the description. What do you think?

tn0ms pushed a commit to warashibe/marked that referenced this pull request May 27, 2026
[docs] Update comment about GitHub breaks

This branch was successfully deployed

1 active deployment
Preview — 9f2c0d16 Deployed Mar 19, 2020 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

category: docs Documentation changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants