killphi / vim-legend

extracted and extended vim plugin for gem https://github.com/nyarly/cadre/
3 stars 0 forks source link

Modeline in README.md #9

Open killphi opened 9 years ago

killphi commented 9 years ago

Hey @nyarly,

Is it really necessary to have the modeline in README.md?

Basically it breaks Markdown for me. Since <blank><blank><newline> means linebreak without new paragraph in Markdown, I can no longer format text that way.

nyarly commented 9 years ago

I really like it there - I don't use EditorConf for instance. I'm certainly open, however, to changing it. Is it the fo+=aw that's causing a problem?

Conversely, Markdown allows raw HTML, so
serves the same effect, possibly more clearly?

killphi commented 9 years ago

Yes, it is the fo+=aw, the w to be exact.

And I handle the setting of the file type elsewhere for all *.md files, which I think is the preferable way and makes this a rather pointless statement in the modeline.

I'd rather prefer as little HTML in the Readme file as possible, since HTML is a markup language not intended to be read in code, whereas Markdown is also nicely readable as plain text.

PS: Regarding .editorconfig, I added it for me and possible contributors that do use it.

nyarly commented 9 years ago

Sadly, .md is also the extension for another filetype.

It's not a huge deal, we can pull it out.

killphi commented 9 years ago

Okay, honestly. Would you ever open Moneydance files with Vim? I am sorry if that sounds belittling, I just find it very unlikely.

However, I'd be thankful if we could just do that. So I guess I owe you one style concession then... :)