No project description provided
Project description
Bestatic
Bestatic is a static-site generator, written in Python and Jinja2 templating engine.
It is truly minimal, yet fully-featured. Like every other static-site generator,
it can generate a complete website by processing a bunch of markdown files. As a result,
it eliminates the need for server-side programming or databases. The site Bestatic generates
in _output
folder can be served from any web server or host (or even GitHub pages or GitLab pages).
Some salient features of Bestatic that are probably worth highlighting:
-
Blog-aware. You can create your blog/news page along with your website and expect all the standard good stuff. Posts will be listed in the reverse chronological order. You can also control number of posts per page.
-
Tags and URL customizations are supported for the posts out-of-the-box.
-
Different description tag for each page of the website (SEO friendly).
-
LaTeX
support is available out-of-the-box. -
Search functionality has been implemented using
Fuse.js
library which enables client-side fuzzy (approximate string matching) search. No action is required from user-end: Whenever the user adds new content and complies the website, it automatically generates a new search index. -
Pre-built site themes (created using Jinja2 template engine, more will be added later; you can add your own as well).
-
Syntax-highlighting for codes is available out-of-the-box.
-
Disqus comments are supported.
-
A simple web server has been included which enables viewing all the changes in the site instantly.
-
Guided quick-start from the command-line.
-
Configurable via a
config.toml
file.
Installation
There are several ways to install Bestatic. The GitHub repo will be updated with more details. For now, please use pip/pipx for installation.
Using pipx (recommended)
If you have not already installed it, please install pipx first using official documentation, as per your OS platform. Next, just use this following command to install Bestatic.
pipx install Bestatic
Using pip
If you are on Linux (Ubuntu/Debian) please use this:
sudo apt update && sudo apt upgrade
sudo apt install python3-venv
python3 -m venv ~/.virtualenvs/bestatic
source ~/.virtualenvs/bestatic/bin/activate
pip install Bestatic
Similar commands can be used to create virtual environment in Windows or mac OS. Bestatic can also be installed inside a conda environment.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for Bestatic-0.0.11-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b380593c0ee2f7178d791f0678762cf2ef2876faa23726c5ba0fe98a33de02ae |
|
MD5 | 26e956b8f73f9a128274af3c372a7fe3 |
|
BLAKE2b-256 | 11d9d7cb041031649a938448ef7856d2fd497a1ffa7de42ecb1a0843a8640283 |