search

matt-diehl / YAPL

A style/pattern guide for sites
5 stars 1 forks source link

Formatting for Module Notes #16

Closed samanthasquared closed 9 years ago

samanthasquared commented 9 years ago

It would be nice to be able to have line breaks and lists in the notes section.

matt-diehl commented 9 years ago

I think there may be a way to format yaml that at least allows for multiple lines: http://symfony.com/doc/current/components/yaml/yaml_format.html

We could look at possibly parsing a section as markdown if it has some indication (maybe just if it's multiline?).

samanthasquared commented 9 years ago

That looks like it would be useful. I do think that support of some kind of formatting would be good to help the readability of these multiline notes.

matt-diehl commented 9 years ago

Formatting the YAML with the vertical pipe retains line breaks, etc. By utilizing the {{markdown}} handlebars helper, we can use markdown inside of one of these multiline comments. and output it properly.

I've documented this in the 1.0.0 readme.