golink: consistent Markdown and text width

tailscale / golink

A private shortlink service for tailnets

BSD 3-Clause "New" or "Revised" License

1.23k stars 79 forks source link

golink: consistent Markdown and text width #97

Closed noncombatant closed 10 months ago

noncombatant commented 10 months ago

In README.md, for easier reading.

Updates #cleanup

willnorris commented 10 months ago

The current line breaks are intentional. See https://sembr.org/ and https://rhodesmill.org/brandon/2012/one-sentence-per-line/

I expect most readers to be viewing the rendered HTML, not the raw markdown, so I don't bother too much about long lines. If there are some that are particularly difficult to read, we could split them, but I generally would not want to combine lines.

tiesmaster commented 10 months ago

@willnorris Thanks for the links of that idea, I wasn't aware of this, but definitely helps in authoring, and makes it even easier to explain this idea to other. Amazing that I haven't come across this before, especially that this even dates all the way back to 1974, almost 50 years old!! (BTW sorry for the offtopic comment, but this really is foundational, and really made my day!!)