rwar

A Simple Static Site Generator
Written in Python

Demo . Blog

Overview

rwar - A simple bare-bones Static Site Generator (SSG) with minimal features. An SSG allows a user to generate a complete HTML website from raw data and files, without having to write out the HTML. Rwar is a command line tool that takes .txt and .md files as input and generates .html files as output.

Usage

Please ensure Python 3 is installed.

The requirements.txt file lists all the dependencies needed for rwar

To satisfy these requirements run the following command pip install -r requirements.txt You can then run the program by running the following command:

# satisfy the dependencies listed in requirements.txt
pip install -r requirements.txt
# (For input either put .txt file or specify the directory containing txt files)
python3 rwar.py -i <input> 

If you are in a Unix environment, you can use the following commands to run:

# make it executable
chmod +x rwar.py 
# run
./rwar.py -i <input> 

Note: If you are not in Unix env, you may need to use python instead of python3.

Flags

Flag	Description	Required / Optional
-i	Specify raw data directory or file e.g. use data directory in the repo	Required
-o	The program will generate a static site in the ./dist directory within the project by default. You can change this behavior by using the -o flag. If you choose to specify your desired directory, it will create dist as a sub-folder within the directory you specify.	Optional
-s	Provide a custom stylesheet by using the -s flag By default it uses water.css	Optional
-l	Indicates the language to use when generating the lang attribute on the root element	Optional
-h	This will display all the available options and usage of rwar	Optional

Features

• Generates a static site from a directory of text and markdown files (only headers) and creates dist folder with the generated HTML files.
• Lets you add custom stylesheet to the generated HTML files.
• Lets you specify the output directory.
• Generates list of all the generated HTML files in index.html file.
• Markdown support for horizontal rule
• Language attribute of the site can be specified