Pelletron is yet another static site generator. Every modern programmer must reinvent this particular wheel.
Pelletron aims to minimize the effort of creating rich content, imposing as little overhead as possible to provide this power.
Pelletron is written in Python. Jinja2 is its templating language. Flask is the glue, providing utilities to build, serve (while debugging), and deploy the static pages. The FlatPages extension defines page content, using YAML to define the structure. It supports Markdown for text formatting and pygments for code syntax highlighting. The Frozen-Flask extension converts the templates to static pages.
Pelletron lets you preview your site using Flask's built-in development server, and includes Flask-DebugToolbar.
Rsync handles deployment to the target server.
Override the skeleton starter templates with widely used HTML5 frameworks such as Bootstrap, Foundation, and HTML5 Boilerplate. (See Beyond bare bones below for more information.)
For Linux and OS X:
- Clone this repository:
git clone firstname.lastname@example.org:jeffkayser/pelletron.git
- Create a new python virtual environment:
- Ensure you're using the new virtual environment:
- Install the requirements:
pip install -r requirements.txt
- Test the site build process:
python site.py build
- You may see some warnings; it's safe to ignore them
- Test the server:
python site.py server
- Use your web browser to navigate to
- You should see a page with the following text at the top appear:
Pelletron is working
- Deploy to localhost as the current user:
python site.py deploy
config.pyto change deployment options such as host, username, and path.
Beyond bare bones
Vanilla Pelletron is not opinionated beyond its basic technical structure, which is optimized for content not design, and provides none of the common HTML5 frameworks popular as jump-off points today. However, modules for the following frameworks are available for your use immediately:
These frameworks can give you a much stronger jumping off point if your site's design needs match up with their respective authors' choices.
Copyright and License
Copyright © 2015 Jeff Kayser. Released under the MIT license.