search

asciidoctor / asciidoctor-backends

Backends (i.e., templates) for Asciidoctor, a Ruby port of AsciiDoc.
http://asciidoctor.org
Other
65 stars 73 forks source link

Trim the ERB backend down to a handful of examples #118

Open mojavelinux opened 9 years ago

mojavelinux commented 9 years ago

The ERB backend is exceptionally difficult to maintain because ERB templates are very complex. In order to ensure we are providing a sufficient reference that is well-maintained and tested, I propose that we trim the ERB backend down to a handful of templates (perhaps 3; one block, one inline and perhaps section) so they merely demonstrate the possibility of using ERB without the maintenance overhead (i.e., nightmare).

jirutka commented 9 years ago

:+1:

mojavelinux commented 9 years ago

Make a strong point in the README that we recommend using slim templates over ERB templates for anyone that is considering creating a set of custom templates. We should point out that ERB is complex and that, in our experience, the templates were exceptionally hard to maintain when done in ERB. In contrast, the templates are simple and clear when done in Slim and we have convenient facilities for simplifying the templates further with utility methods. Slim is a smarter engineering choice. To choose ERB is to choose a technology that is knowingly more expensive and tedious to maintain.