all repos — h3rald @ 249c3c941ce0620e553661dd4c4c8fe695b2c0d0

The sources of

Writing nanoc review/tutorial.
Wed, 16 Sep 2009 17:33:31 +0200




1 files changed, 24 insertions(+), 11 deletions(-)

jump to
M content/articles/creating-smart-static-sites-with-nanoc.textilecontent/articles/creating-smart-static-sites-with-nanoc.textile

@@ -9,7 +9,7 @@ - writing

- opensource :date: 2009-09-15 13:32:51.049000 +02:00 :permalink: creating-smart-static-sites-with-nanoc -:title: "Creating Smart Static Sites with Nanoc" +:title: "Creating Smart Static Sites with nanoc" :toc: true -----

@@ -37,12 +37,12 @@ bq. [...] Webby works by combining the contents of a page with a layout to produce HTML. The layout contains everything common to all the pages — HTML headers, navigation menu, footer, etc. — and the page contains just the information for that page. You can use your favorite markup language to write your pages; Webby supports quite a few.

There are quite a few applications like Webby, such as: * "nanoc": -* "rassmalog": +* "Rassmalog": * "Jeckyll": * "WebGen": -* "rog": +* "Rog": * "Rote": -* "hobix": +* "Hobix": * "RakeWeb": * "RubyFrontier": * "StaticMatic":

@@ -53,23 +53,36 @@ * "NanoBlogger":

There are probably even more, with different features, but they all try to solve the same problem: provide a way to generate static web sites in an automated way. -h3. Choosing the right tool for your needs +I spent some time reading about each one of them, "evaluating the pros and cons": and in the end I decided to go for "nanoc":, simply because it was the only one that seemed to fit all my needs. + +h3. A quick overview of nanoc + +nanoc (*nano* *c*ompiler) is a nifty tool written in Ruby suitable for _[...] building small to medium-sized websites_. In other words, anything which doesn't involve some fancy user interaction. For what concerns blogs, the only user interaction is _comments_ – but that's fine, because there's more than one web service for that, such as "Disqus": or "IntenseDebate": + +h4. Some details on the project + +Compared to the alternatives, nanoc is one of the most mature and most maintained, having hit just a few weeks ago its 3.0 release. Its creator, Denis Defreyne, uses it for his own "web site": and is involved with the project on a daily basis, both coding and offering support to nanoc users like myself who regularly ask questions on the "nanoc user group": + +Denis also seems very concerned about keeping documentation up-to-date – something that really impressed me from a technical writer's point of view. The "tutorial": he put together will get you started in no time, and the "manual": will explain everything else you may possibly want to know. When release 3.0 came out he even put together a "migration guide": If this is still not enough and you don't mind spending some time extending the system, nanoc's "RDoc documentation": is very comprehensive compared to other Ruby projects. + +h4. Sites, Items and data sources + +h4. Layouts, filters, and helpers - +h4. Rules and tasks + h3. Migrating from your blogging platform - -h3. Using metadata +h4. Posts and pages +h4. Tags -h3. Integrating 3rd-party services +h4. 3rd-party services h3. Conclusion - h4. Advantages - h4. Disadvantages