Skip to content

Latest commit

 

History

History
102 lines (65 loc) · 2.78 KB

README.rst

File metadata and controls

102 lines (65 loc) · 2.78 KB

paragoo

PyPI version PyPI license Code Health Codacy Badge

paragoo is a static site generator, written in Python. It takes a simple yaml file with the structure of the site, the source Markdown/HTML content files and the Jinja2 based templates and builds a directory structure with the final website.

Installation

From PyPI

Assuming you already are inside a virtualenv:

pip install paragoo

From Git

Create a new virtualenv (if you are not already in one) and install the necessary packages:

git clone https://github.com/aquatix/paragoo.git
cd paragoo
mkvirtualenv paragoo # or whatever project you are working on
pip install -r requirements.txt

Usage

Run python paragoo.py to get help. Typically, a command line looks like this:

python paragoo.py generate_site -s /path/to/site_config -t /path/to/site_templates -o /path/to/output_dir

A more involved command including a Secure CoPy to a remote server can look like this:

python paragoo.py generate_site --clean -s ../aquariusoft.org/site -t ../aquariusoft.org/templates -o /tmp/aqs --clean; scp -pqr /tmp/aqs/* vps01:/srv/aquariusoft.org/

or:

python paragoo.py generate_site --clean --cachebuster -s ../../../website/mydomain.net/site -t ../paragoo-theme-material/build/material-grey --pathprefix page --makerooturi -o /srv/mydomain.net

To see what commands are available, run paragoo with --help:

python paragoo.py --help

or:

python paragoo.py generate_site --help

Templates

Some pre-made templates to go with paragoo: paragoo material theme.

parawah?

The name is derived from παράγω, which is Greek for ‘generate’, ‘produce’.

What's new?

See the Changelog.