Static website generator inspired by jekyll based on flask.
Flekky is a static website generator inspired by Jekyll but written in python and based on Flask. It is basically a wrapper around the excellent Frozen Flask and Flask FlatPages as described in this article by Nicolas Perriault.
So what does it do? It allows you to write templates, assets and contents for your website and bake all that into static HTML. You can than deploy that HTML on any webserver and do not have to worry about anything. Jinja2 is used for templating. Markdown is used for creating content.
There are many static website generators out there of which Jekyll is arguably the most popular. You are probably better of with that. But if you like Flask and have fun experimenting with things you might give Flekky a try.
$ pip install flekky $ flekky --source _example build
You can generate static HTML by using the build command:
$ flekky build
Flekky also comes with a built-in development server that will allow you to preview what the generated site will look like in your browser locally:
$ flekky serve
A basic Flekky site usually looks like this:
_source ├── pages │ ├── index.md │ └── test.md ├── static │ ├── css │ │ └── style.css │ └── js └── templates ├── base.html ├── category.html ├── layout │ ├── default.html │ └── post.html └── tag.html
An overview of what each of them does:
- pages: Your dynamic content, so to speak. These are Markdown files, but they also contain some YAML data at the top. index.md is special because all its metadata is added to site , so you can use it to set the title of the complete website.
- templates: You will probably want to include a base.html that all other templates can extend. category.html and tag.html are used to render category and tag pages respectively. Layouts are used to render pages.
- Any additional files from the root folder that do not begin with an underscore (_) or dot (.) will be copied verbatim.
Flekky has several command-line options:
- --source: directory where Flekky will read files (default: _source)
- --future: include pages with dates in the future (default: false)
- --unpublished: include unpublished pages (default: false)
- --destination: directory where Flekky will write files (default: <source>_build)
- --port: port to run at (default: 8000)
Flekky makes a variety of data available to the templating system. The following is a reference of the available data.
A page is a Markdown file in the pages folder. However, at the top of the file you can (and should) set some meta data using YAML syntax. All key-value pairs defined here will be available in the templates. But some fields also have a special meaning:
- title: Title for this page.
- layout: Select a template from the layout folder for rendering (default: default).
- published: Unpublished pages will not be included in the website. This can be disabled using the --unpublished command-line option.
- date: Pages with dates in the future are not included in the website. This can be disabled using the --future command-line option.
- category: Each page can be filed under a single category. It will be included on the category page.
- tags: Tags can be used to categorize pages. They are very similar to categories with the difference that a page can have multiple tags.
The site object stores all data that applies to the whole project. This also includes any metadata from index.md.
- title: Title of the website.
- time: Current time. This can be used to display the time of the last build.
- pages: A list of all pages.
- categories: A list of all used categories.
- tags: A list of all used tags.
- config: The complete configuration.
Differences from Jekyll
Flekky aims at being very similar to Jekyll. However it is far from being a drop-in replacement. Some of the missing features might be added in the future. For now, these are some of the most important differences:
- written in python and based on Flask
- Markdown only (though it should be easy to extend)
- slightly different directory structure
- no configuration file like _config.yml
- templates instead of _includes and _layouts
- pages instead of top level files and _posts
- no drafts
- no data files
- date is not encoded in file name
- only pages that are linked to are included in the build
- no build-in SCSS or CoffeeScript support
- different (but similar) templating syntax
- no separators before and after YAML data in page files
- no build-in pagination
- no build-in plugin system but the rich Flask ecosystem
Copyright (C) 2014 Tobias Bengfort firstname.lastname@example.org
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.