Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace/Deprecate TLDR008 #93

Open
SethFalco opened this issue Jul 29, 2021 · 3 comments
Open

Replace/Deprecate TLDR008 #93

SethFalco opened this issue Jul 29, 2021 · 3 comments

Comments

@SethFalco
Copy link
Member

Markdown files depend on trailing whitespace to add a line break without creating a new paragraph.

image

Due to our .editorconfig and TLDR008, we don't have 2 spaces between the description and more information link. This makes websites and other Markdown renderers render them on the same line.

For example, this issue occurs when viewing files on GitHub and on tldr.ostera.io.

I think TLDR008 should be replaced with a similar rule that disallows trailing whitespace on all lines except the page description.
Following this, our .editorconfig should include the rule:

[*.{markdown,md}]
trim_trailing_whitespace = false

Actual

image

Expected

image

@SethFalco
Copy link
Member Author

An alternate solution could be the following:

It introduces an alternative syntax for hard line breaks, a backslash at the end of the line, supplementing the two-spaces-at-the-end-of-line rule. This is motivated by persistent complaints about the “invisible” nature of the two-space rule.
- https://github.com/commonmark/commonmark-spec#differences-from-original-markdown

So to leave this rule intact, but require a \ at the end of the line before the more info line.

@marchersimon
Copy link
Contributor

I'm not a fan of how that would look, but two spaces after each line isn't really better. Also, it would be annoying if we would have to make sure every contributer follows this syntax. I assume we also can't automatically add them, since that would prabably create issues for contributors when pushing new changes without pulling.

@github-actions github-actions bot added the Stale label Apr 7, 2023
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale May 7, 2023
@SethFalco
Copy link
Member Author

Reopening this as it's still an issue as long as declare we use Markdown files.

@SethFalco SethFalco reopened this May 7, 2023
@github-actions github-actions bot removed the Stale label May 8, 2023
@github-actions github-actions bot added the Stale label May 23, 2023
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Jun 22, 2023
@SethFalco SethFalco reopened this Jun 22, 2023
@github-actions github-actions bot removed the Stale label Jun 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants