Opened 9 years ago

Closed 9 years ago

#4165 closed enhancement (invalid)

research migrating website from wml to markdown and jekyll

Reported by: phobos Owned by: phobos
Priority: Medium Milestone:
Component: Webpages/Website Version:
Severity: Keywords:
Cc: Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description

We currently use the website meta language, http://thewml.org/, as our template system for creating the static html for the website. A more modern template system is Jekyll, http://jekyllrb.com/. We could do a better job of separating the content from the html itself by using markdown for all of the content, stored in distinct files, and then apply the html template using the YAML included in Jekyll.

Having separate content may also improve our ability to include it as documentation with our software bundles and compiled as manuals for users. This separation may also improve our ability to translate the content without having to worry about conversion from html to the po format.

Markdown is a language which can be converted from its plaintext form into various other formats, http://daringfireball.net/projects/markdown/.

There would be a lot of work to setup the new site, convert the documentation, and merge in the current theme. However, the end result would be a more flexible arrangement for the future. New designs and templates could be applied more easily without the need to rewrite all of the content as well.

Child Tickets

Change History (7)

comment:1 Changed 9 years ago by atagar

Another templating alternative which I'm considering for my site is Hyde:
http://ringce.com/hyde

It performs static compilation of django templates, so it'll already be familiar to anyone with some django experience. Of course the choice is up to whoever is doing the conversion work.

comment:2 Changed 9 years ago by phobos

Status: newaccepted

And here's my progress so far, https://gitorious.org/tor-web-conversion

comment:3 Changed 9 years ago by Sebastian

Are you still pursuing this? Or should 3242 be revived? Also, it seems we now have the short user manual rather than the website translations, so I'm wondering if this is still active

comment:4 Changed 9 years ago by phobos

I started it and then got buried with other work. I'd still like to get more into it before deciding if it's good or bad.

comment:5 Changed 9 years ago by Sebastian

Ok. I was wondering because it seemed that now that translations are gone, the main issue with wml is also non-existent anymore.

comment:6 Changed 9 years ago by phobos

Translations were orthogonal to the migration. The real goal is to separate content from the structure and display of the website. If we're going to keep a generated, static website (which I believe we should do) then wholly separating the content from the rest of the website should make our lives easier. This could have a secondary effect of making translations easier in both right-to-left and left-to-right languages now that you don't have to have single lines with wml and other commands within them.

One of the things I'm blocking on is figuring out a navigation system that doesn't rely upon tags inside the content. Or at least one that relies upon standard hyperlinks inside the content, when pointing to other pages in the site. I'm open to ideas for all of this. I started doing this in gitorious to let others clone, fork, and commit back to the project some code.

comment:7 Changed 9 years ago by phobos

Resolution: invalid
Status: acceptedclosed

this is never going to happen, closing.

Note: See TracTickets for help on using tickets.