Bestatic | The Best Static Site Generator!

Bestatic Documentation

Bestatic is a minimal yet fully-featured static site generator built with Python and Jinja2 template engine.

Please browse through the pages listed below to get started and to explore in-depth. If you have any questions, please feel free to contact me on GitHub Discussions.

Quickstart

Qucikly learn how to build a site with Bestatic, without delving into nitty-gritty technical details.

Installation

Learn how to install Bestatic in different platforms such as Windows, Linux, and macOS (and in development mode with a virtual environment).

Content Management

Learn how to manage the content of your site with Bestatic, including creating new pages and posts, front matter, directory structure, homepage options, commenting systems, search, sitemap, custom taxonomies, and more!

Configuration File

Learn how you can easily alter pretty much all the configuration settings of your website using a simple but powerful .yaml file.

Markdown Processing

Learn how to process the markdown files (the building block of your website) and what add-ons are available, including multi-column layouts, custom extensions, extension configs, emojis support, and a few custom shortcodes.

Data Handling

Learn how to handle the data of your site with Bestatic, including taxonomy data files, custom data files, markdown data files, and images.

Image Processing

Learn how to process the images of your site with Bestatic, including styling the images and image optimization.

CLI Options

This page lists all the command line options that Bestatic provides and tell you how to use them.

Themes

Learn how to use the themes of Bestatic, including using a theme, creating a theme, and example Jinja2 templates for your own theme.

Deployment

Compiled Bestatic site can be deployed basically anywhere. Learn how to do automate it on popular platforms.