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

Allow line break HTML elements in Markdown files #5089

Merged
merged 1 commit into from
Oct 8, 2024

Conversation

twz123
Copy link
Member

@twz123 twz123 commented Oct 8, 2024

Description

The idiomatic way to add line breaks in Markdown files is to use two trailing spaces at the end of a line.

This poses some challenges:

  • Hard to spot if there's no editor support for highlighting whitespace.
  • Editors may remove them automatically, as whitespace at the end of a line is typically regarded as superfluous.

The <br> inline HTML element serves the same purpose, so let's make an exception for it.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

How Has This Been Tested?

  • Manual test
  • Auto test added

Checklist:

  • My code follows the style guidelines of this project
  • My commit messages are signed-off
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings

The idiomatic way to add line breaks in Markdown files is to use two
trailing spaces at the end of a line.

This poses some challenges:

* Hard to spot if there's no editor support for highlighting whitespace.
* Editors may remove them automatically, as whitespace at the end of a
  line is typically regarded as superfluous.

The inline HTML element serves the same purpose, so let's make an
exception for it.

Signed-off-by: Tom Wieczorek <[email protected]>
@twz123 twz123 added documentation Improvements or additions to documentation chore labels Oct 8, 2024
@twz123 twz123 requested a review from a team as a code owner October 8, 2024 08:38
@twz123 twz123 requested review from ncopa and makhov October 8, 2024 08:38
@twz123 twz123 merged commit d71e92b into k0sproject:main Oct 8, 2024
92 checks passed
@twz123 twz123 deleted the allow-line-breaks-in-markdown branch October 8, 2024 12:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants