Better linebreaks in Markdown

Maëlle Salmon

https://maelle.github.io/cynkranize-aeolus

Are those Markdown chunks equal?

This is a sentence. This is another
sentence.

and

This is a sentence. 
This is another sentence.

Yes?

Same output in resulting HTML or so.

No!

This is a sentence. 
This is another sentence.

is better for Git diffs in particular!

Semantic linebreaks

When writing text with a compatible markup language, add a line break after each substantial unit of thought.

https://sembr.org/

Better Git diffs

  • More readable.
  • Easier to make comments or suggestions on in PRs. Example.

Better translations?

Babeldown issue

How to use semantic linebreaks?

✨ Get used to it ✨

⚠️ There is no way back ⚠️

How to use linebreaks at the end of sentences

RStudio IDE’s Visual Markdown editor with the correct wrapping option

aeolus::use_sentence_linebreaks()

How to fix a file that has no linebreaks at the end of sentences?

Before you review it for instance.

aeolus::unleash() demo

How does it work

Caveats of aeolus

Some formatting changes, same limits as {tinkr}.

Questions

  • What do you use for writing prose?

  • What do you use for reviewing prose?

  • Do you care about semantic linebreaks?

https://maelle.github.io/cynkranize-aeolus