You are here: home / projects / minimalsite

MinimalSite

minimalsite is a fast minimal static website builder. It generates web pages from a file hierarchy with markdown and textile syntax.

                                                   _
                   o          o                   | |     o
         _  _  _       _  _       _  _  _    __,  | |  ,    _|_  _
        / |/ |/ |  |  / |/ |  |  / |/ |/ |  /  |  |/  / \_|  |  |/
          |  |  |_/|_/  |  |_/|_/  |  |  |_/\_/|_/|__/ \/ |_/|_/|__/

Download:

Git repository on github

git clone git://github.com/lavish/minimalsite.git

Requirements

In order to run minimalsite you need a working Python 2.X or 3.X installation and the following modules:

Installation

There's no need to install the tool: download, unpack and run.

Running minimalsite

Usage: minimalsite.py [options]

Options:
  -h, --help                     Show help options
  -V, --version                  Display minimalsite version
  -v, --verbose                  Display the entire tree structure
  -t, --template=TEMPLATE        Specify a template
  -s, --src_dir=SOURCE_DIR       Specify source dir to use
  -d, --dst_dir=DESTINATION_DIR  Specify destionation dir to use

SOURCE_DIR is the directory containing the source file hierarchy and DESTINATION_DIR the directory where you want to create web pages.

You can also add different templates under the templates/ directory and specify TEMPLATE using your template file name. For example, to use templates/minimalblue.py, you will run ./minimalsite -t minimalblue ...

Please note that you need to place an index file in in each directory you want to parse, otherwise those directories will be ignored.

Configuration

You can create your own template starting from templates/default.py. See comments inside for help. Templates provide a very flexible tool for building your site adding how many functions and features you want; See templates/example.py for a more advanced template.

Extra Features

Page ordering

If you need to order menu entries, add a numerical index before the pathname, for example:

/home/marco/website/30_university.md
/home/marco/website/50_contacts.md

will be written as:

/var/www/marco/htdocs/university.html
/var/www/marco/htdocs/contacts.html

and "university" will be displayed before "contacts" in the menu. Both files and directories are supported.

Misc

Please refear to Markdown Syntax and Textile Syntax documentation before writing your pages.

Author/Credits

Minimalsite is written by Marco Squarcina <lavish at gmail dot com>

The following people have contributed to this project: