ambisonictoolkit / ambisonictoolkit.github.io

Website - using Jekyll and Bootstrap
GNU Lesser General Public License v3.0
12 stars 4 forks source link

Support for textilize and/or kramdown - and update to pages #16

Open lossius opened 8 years ago

lossius commented 8 years ago

Some of the websites currently has a not-so-delicious mix of markdown and html tags, mostly the pages where we make active use of Bootstrap classes. It would be nice to make the source files more readable by substituting html for simpler marking serving the same purpose.

Markdown itself, for ideological reasons, do not provide much in terms of formatting utilities, it's mostly a format with an emphasis on structure.

Two possible solutions would be to use Kramdown, which seems to extend markdown with a superset that includes the ability to define HTML classes for CSS styling:

http://kramdown.gettalong.org/quickref.html

or switching from markdown to textile. In the latter case we'll have to move some pages to .textile instead of .md. It might be that kramdown is already being used by Jekyll, but that we do not make full use of it yet.

joslloand commented 8 years ago

@lossius Agreed, "something should be done!"

In terms of editing I find Markdown very easy, but, yes, using both Md and HTML leads to very confusing sources.

Sounds like the immediate issue at hand is to decide between kramdown and Textile. In the Wikipedia discussion of Textile, Markdown is described as progenitor.

Just in terms of "newest", I think I'd lean towards kramdown, particularly if kramdown is already supported by Jekyll.

lossius commented 8 years ago

GitHub no longer supports textile:

https://github.com/blog/2136-a-look-behind-our-decision-to-standardize-on-a-single-markdown-engine-for-github-pages

so kramdown is the only option here. A kramdown reference can be found here:

http://kramdown.gettalong.org/quickref.html

I guess the best step forward is to make a test page and see how that behaves.

joslloand commented 8 years ago

Ok, that sounds sensible. Will look forward to hear how you've found it to work.