Metadata-Version: 2.1
Name: pyssgen
Version: 1.0.5
Summary: Static site generator built with python
Home-page: https://github.com/ken-soares/pyssgen
Author: Kenneth Soares
Author-email: kensoares@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENCE

# pyssgen

[![PyPI version](https://badge.fury.io/py/pyssgen.svg)](https://badge.fury.io/py/pyssgen)

pyssgen is a lightweight alternative to hugo and other static site generators.
I used it to build my static blog and included the templates and css that I use along with it.

Please note that it's only a side project and might not be suitable for bigger
websites.


## Installation

### via pip (recommended)

```python
>>> pip install --user pyssgen
```


## Usage

### if installed with pip

```python
>>> python3 -m pyssgen <input-dir> <output-dir> <templates-dir>
```

## templates

In order for pyssgen to work you need to provide a `templates/` directory containing:
* [base.html](https://github.com/ken-soares/pyssgen/blob/main/pyssgen/templates/base.html) the shared headers between all pages,
* [home.html](https://github.com/ken-soares/pyssgen/blob/main/pyssgen/templates/home.html) for the main page of the website,
* [post.html](https://github.com/ken-soares/pyssgen/blob/main/pyssgen/templates/post.html) for "posts" or any other pages

If you don't know how to write templates using jinja,
you can copy the premade [templates](https://github.com/ken-soares/pyssgen/tree/main/pyssgen/templates) folder.

## css
`static/` folder will be created automatically in parent directory if it doesn't already exist, you can place your `styles.css` inside `dist/static`. Otherwise, the pages won't have styling. If you are not sure how to work with css, you can copy the css from this repository.
