Rattlesnake Demo Website

This is a demo website for the Rattlesnake static site generator. It is written in the Python programming language and utilizes the Jinja templating engine, pySCSS for SCSS support, as well as the pyYaml library for parsing config files.

Usage

Rattlesnake needs the following things:

The build follows the convention that files starting with an underscore (e.g. _header.html) are not built as pages, but used as template files via Jinja. All HTML files not starting with an underscore will be converted into pages. Files with the name index.html will keep their relative path. However, all other HTML files will be moved into a directory with the same name as the original file (without extension) and stored as an index.html inside that folder. This means that a file ./src/about.html will be processed into a file ./build/about/index.html. This is due to the way the browser and the web server handle paths. This creates nicer looking URLs (https://youwebsite.org/about instead of https://youwebsite.org/about.html).

Command-Line Interface


        usage: Rattlesnake Static Site Generator [-h] [-w] [-o OUTPUT_DIR] [-p PORT] [-c CONFIG_FILE] [source_dir]

        positional arguments:
        source_dir

        optional arguments:
        -h, --help            show this help message and exit
        -w, --watch
        -o OUTPUT_DIR, --output-dir OUTPUT_DIR
        -p PORT, --port PORT
        -c CONFIG_FILE, --config-file CONFIG_FILE