handroll - A website generator for software artisans¶
handroll is a static website generator that uses markup languages like Markdown, reStructuredText, and Textile.
handroll is available for download from PyPI. You can install it with
handroll is currently supported on Python
$ pip install handroll
When inside a website’s source directory, the following command will generate
results and store them in
handroll -h to see all the
$ handroll build Complete.
handroll follows a “batteries included” philosophy for generating static websites. One goal is to support a wide range of tools to cater to many diverse interests. The list below isn’t exhaustive, but it provides a good idea of what handroll is capable of doing.
- Start a new site with a single command using Scaffolds for immediate results.
- Convert Markdown to HTML.
- Convert reStructuredText to HTML.
- Convert Textile to HTML.
- Convert Sass to CSS.
- Track blog entries and automatically generate a feed (see Blog extension).
- Generate a proper Atom XML feed from metadata stored in JSON.
- Produce metadata for popular social media site like Facebook and Twitter.
- Run a development server with the
watchflag to monitor your site and update the output immediately as you make changes (see Development server).
- Find the site source root so you don’t have to. If you’re anywhere in your
site’s source, calling
handrollwithout the site input parameter will trigger handroll to look for your site’s root directory.
- Store global configuration in a configuration file (see Configuration). You’ll never need to specify the output directory again.
- Keep extra data for templates in a separate front matter section in YAML format (see Front matter).
- Templates can use the Jinja2 template engine.
- Content is only updated when either a template or the source file is newer than the existing output file. This eliminates wasted regeneration on unchanged content.
- Be extensible for users who want to write their own plugins (see Composers and Extensions).
- Provide timing information to see file processing time.
- Translated to many different languages.
The remaining documentation provides additional details about all listed features.
- Front matter
- Development server
- Built-in composers
- Built-in extensions
- Version 4.0, In Development
- Version 3.1, Released December 26, 2016
- Version 3.0, Released March 7, 2016
- Version 2.1, Released October 18, 2015
- Version 2.0, Released July 25, 2015
- Version 1.5, Released February 24, 2015
- Version 1.4, Released December 1, 2014
- Version 1.3, Released September 3, 2014
- Version 1.2, Released July 2, 2014
- Version 1.1, Released June 1, 2014
- Version 1.0, Released May 4, 2014