Readme.md

   1 # Readme
   2
   3 ## Overview
   4
   5 BiaWeb2 is a static site generator written in C++, that takes a directory tree
   6 of documents (in Markdown format - more on that later) and outputs a website
   7 with the same tree structure, based on a set of templates.
   8
   9 BiaWeb2 supports infinite nesting level of source sub-directories, with
  10 each directory representing a "category". Thus, a website can have (say)
  11 a structure like
  12     + Home
  13       + ----- Blog
  14       + ------+------ Travel
  15       + ------+------ History
  16       + ------+------ Personal
  17       + ------+------ Technology
  18       + ----- Creative
  19       + ------+------ Reviews
  20       + ------+------ +------- Books
  21       + ------+-------+--------+-------- Fiction
  22       + ------+-------+--------+-------- Non-fiction
  23       + ----- Miscellaneous
  24
  25 Thus the entire structure of the website is represented by the filesystem
  26 hierarchy of directories (which I think is an intuitive way of organizing
  27 categories).
  28
  29 `biaweb2` is a command-line program that performs the entire website
  30 generation in one step. The usage is:
  31
  32     biaweb2 -i <inputdir> -o <outputdir> -t <templatedir> [-q]
  33
  34 Where `<inputdir>` is the input directory, `<outputdir>` is the destination
  35 directory and `<templatedir>` is the location of the template files. The
  36 `templates` directory in the __biaweb2__ source package provides a default
  37 template that can be further customized to suit your needs. The main philosophy
  38 of BiaWeb2 is to be as configuration-free as possible and hence most of the
  39 customization for a specific website is within the templates themselves. The
  40 option `-q` is quiet-mode, to suppress the messages.