Webber

Webber is a static web-site generation tool, loosely based on ideas from IkiWiki and my own likings.

It works by ...

Finally webber creates static HTML files that you can upload to your web-site. I recommend sitecopy for this.

TutorialÂ

First, make an empty directory and change into it:

$ mkdir web
$ cd web

Then, get webber:

$ git clone --depth 1 git://gitorious.org/webber/webber.git

Now we need a directory for our input files and output files:

$ mkdir in out

and create our first page using your favorite ${EDITOR}. It should look like this:

$ ${EDITOR} in/index.conf
$ cat in/index.md
title: Nothin' about me

Hi, I'm Holger and I won't tell you more about me :-)

I'm using markdown here (you can also use RST or HTML, or even have some pages in one format and other pages in another format).

Now, webber needs a simple config file. Create one, it should be similar to this:

$ ${EDITOR} webber.conf
$ cat webber.conf
template: "default"
plugins: [
    "link",
    "read_markdown",
    "template_mako",
    ]

As you see, we specified a template. That's a HTML skeleton that webber fills out. Let's create a very simple one:

$ mkdir in/style
$ ${EDITOR} in/default.tmpl
$ cat in/default.tmpl


${file.title | entity}



${file.title | entity}
${body}

And finally, we can run webber without any command line options:

$ webber/webber
info: Reading files ...
info: Scanning files ...
info: Rendering files ...

If "webber/webber" is too cumbersome to type, just do this:

$ ${EDITOR} Makefile
$ cat Makefile
all:
    webber/webber

Now can can simply type "make".

Now you wonder what file has been produced? Let's see:

$ cat out/index.html


Nothin' about me



Nothin' about me
Hi, I'm Holger and I won't tell you more about me :-)

You make things way more complex, but that's basically it.

Changed 2011-01-13 in Webber: Functions - remove reference to show_orphan (english)
Changed 2010-07-06 in Webber: Webber - added Tutorial (english)
Changed 2010-07-06 in Webber: Configuration - enhanced, fixed and clarified (english)
Changed 2010-07-06 in Webber: Configuration inheritance - various clarifications, a better example (english)
Changed 2010-07-06 in Webber: Hooks - new introductory text about hooks (english)
Changed 2010-07-06 in Webber: Page format - enhanced section on page body (english)
Changed 2010-06-24 in Webber plugins: Generate table of contents - make get_toc() work like get_recently() (english)
Created 2010-06-23 in Webber plugins: RSS feed generator (english)
Changed 2010-06-23 in Webber plugins: Mako templates - finally documented how templates work (english)
Changed 2010-04-23 in Webber plugins: Read and copy binary files (english)