pysen - static site generator

Fast, lightweight, static site generator written in Python.

Visit https://hasithsen.pages.dev/verse/ for a live demo.

Table of Contents

• About
• Getting Started
• Usage

About

Pysen (stylized as pysen) is a simple static site generator focused on building text-only websites.

Features

• Simple Configuration: Easily configure and customize your site.
• Markdown Support: Write your content in Markdown, allowing for easy content creation and editing.
• Themable: Use your own to personalize the look and feel of your site.
• Fast and Efficient: Generates static HTML pages, ensuring quick loading times and optimal performance.
• Asset Management: Automatically handles assets such as stylesheets and JavaScript. Image handling is not yet implemented.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Since Pysen is written in Python, you need to have it installed on your system, preferably a version newer than Python 3.6.

To install Python, follow the instructions at official Python website https://www.python.org/downloads/.

Running

If you already have Python installed, clone or download this GitHub repository to your local machine and you are ready to go!

# create a Python virtual env
python3 -m venv venv

# activate Python virtual env
. ./venv/bin/activate

# install requirements
pip3 install -r requirements.txt

Usage

Run below in your terminal for a list of supported options.

python3 pysen.py -h