From: Holger Schurig Date: Tue, 6 Jul 2010 11:23:39 +0000 (+0200) Subject: doc: added tutorial X-Git-Url: https://oss.titaniummirror.com/gitweb?p=webber.git;a=commitdiff_plain;h=680acc6d9d4ecf0839983c0a7fa95812bf5830dc doc: added tutorial --- diff --git a/in/index.md b/in/index.md index bb87de3..20fcb3a 100644 --- a/in/index.md +++ b/in/index.md @@ -1,7 +1,8 @@ title: Webber lang: en ctime: 2009-06-24 -mtime: 2009-06-24 +mtime: 2010-07-06 +change: added Tutorial *Webber* is a static web-site generation tool, loosely based on ideas from IkiWiki and my own likings. @@ -19,7 +20,97 @@ Finally webber creates static HTML files that you can upload to your web-site. I recommend [[sitecopy|http://www.manyfish.co.uk/sitecopy/]] for this. -= More Info += 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|read_markdown]] here (you can also use +[[RST|read_rst]] or [[HTML|read_html]], or even have some pages in one +format and other pages in another format). + +Now, webber needs a simple [[config file|configuration]]. 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|template_mako]]. 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|commandline]]: + + $ 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. + + += More Info = * [[pageformat]] * [[configuration]] @@ -35,6 +126,9 @@ for this. * [[hierarchy]] * [[template_mako]] * [[skeleton]] + * [[google_sitemap]] + * [[rss_feed]] + * [[skeleton]] * [[hooks]] * [[functions]] * [[macros]]