Skip to main content

State of the art static website generator for humans

Project description

SiteFab: state of the art static website generator for humans

Linux Status macOS Status Code coverage

Getting Started in 30 seconds

Here is how to install SiteFab, Create a new site and compile it in less than 30 seconds:

# install the main package
pip install sitefab

# clone the site template as base
git clone https://github.com/ebursztein/sitefab-template.git mysite/

# clone the plugins in your site directory
git clone https://github.com/ebursztein/sitefab-plugins.git mysite/plugins

# generate your shiny new site
sitefab -c mysite/config/sitefab.yaml generate

Et voila! you know have a fully fonctional site that can be statically compiled. As the next step you should add your content, customize the html templates and tweak the plugins configuration to your liking!

Key Features

Here are some of the key highlevel functionalities that makes SiteFab the static generator of choice for modern websites:

  • State of the art images processing stack: The images stack generate out of the box all you need to use image in optimal fashion including: reactive images for the <picture> element, webp versions for the browsers who support it, frozen thumbnail for the loading and cropped thumbnails for previews.
  • Bleeding edge natural language processing stack: Leveraging the latest advance in NLP Sitefab offers: An accurate list of related posts (LSI algorithm), a client side faceted search and a smart client-side autocompletion
  • Fully customizable: Its flexible plugin system and templatized parser make it easy and fast to customize SiteFab to your needs.

Design principles

Beside its technical features what separates SiteFab from other site generators is its guiding principles:

  • Configuration over convention: Every behavior is explictly specified. There are no special files or directories. SiteFab only do what the site configuration say. Nothing more, nothing less.

  • Content Agnostic: There is only one type of content called post. SiteFab makes no assumption about the content stored in the .md files. Its job is to apply the configuration specified in the frontmatter to render the specificied files and ensure that the enabled plugins are properly executed.

  • Atomicity: Each piece of content is self contained by having its own configuration in its frontmatter including which template to use. This allows to accomodate both complex sites with per page configuration and very simple ones that reuse the same template again and again.

  • Orthogonality: Site configuration, plugins and plugins configuration are independent of the core engine so you can use as many configurations and tweaked plugins you want. Additionally you can check those alongside with your site content to have reproducible build, safe rollbacks and concurrent version of the build pipeline (e.g alpha versus stable).

Alternatives

Here are some popular alternatives if SiteFab is not what you are looking for:

  • Jekyll: The most popular site generate, written in Ruby.

  • Hugo: A popular site generator, written in Go that focuses on speed.

  • Pelican: Another site generator written in Python.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sitefab, version 1.0.1579548281
Filename, size File type Python version Upload date Hashes
Filename, size sitefab-1.0.1579548281-py3-none-any.whl (54.9 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size sitefab-1.0.1579548281.tar.gz (40.8 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page