freedomjs / tutorial

Guide for getting started developing with freedom.js
http://www.freedomjs.org/tutorial/
2 stars 0 forks source link

Set up gh-pages branch #1

Closed agallant closed 9 years ago

agallant commented 9 years ago

For this repository to serve its purpose, it needs a gh-pages branch populated with a static website. It will then appear at http://www.freedomjs.org/tutorial (which is why the repo is called "tutorial" and not "freedom-tutorial").

There's a number of ways to do this, but currently I'm leaning towards using Hugo. Some relevant sources/examples:

Brief summary is that Hugo is a static site generator that will read e.g. Markdown from the main branch, and can be set to output the generated site to the gh-pages branch. It's written in Go and is a bit more self-contained than other common static site tools (e.g. Octopress/Jekyll tend to pull in lots of Ruby stuff). From my initial playing it seems promising, but I'm not dead set on it or anything if others have different preferences (perhaps something more JavaScripty).

So to that end, this issue is for:

Regardless of tooling, Markdown seems the sensible way to make the tutorial, so I'll proceed under that assumption.

agallant commented 9 years ago

Done, w/deploy.sh script. https://github.com/freedomjs/tutorial/blob/master/deploy.sh