Heiwa

Heiwa is currently in BETA state.

Bugs may occurs and there is still a lot of work to do on optimizing the code.

Heiwa is a minimalist flat-file CMS using Markdown to generate HTML pages. There is no build step, as static site generator, since pages are generated on the fly when accessing them from the browser.

The Rust language, also known for is performance regarding strings and files operations, makes Heiwa very fast, to dynamically render web pages.

TODO screenshot

Licence

The Heiwa project is under GPLv3 licence : https://www.gnu.org/licenses/gpl-3.0.en.html

Installation

Depedencies :

sudo apt install libssl-dev # on Ubuntu
sudo dnf install openssl-devel # on Fedora

Using Rust package manager :

cargo install heiwa

Documentation

Initialize a new Heiwa website project :

heiwa init project_name

Add a theme in the project_name/themes/theme_name directory. The Heiwa default theme can be found here : Shizen

Edit the project_name/config.toml file accordingly.

Launch the builtin web server :

cd project_name
heiwa serve

Access your website at localhost:3000.

Contributing

Prerequisites :

sudo apt install libssl-dev pkg-config

Support

For support, please create an issue on Codeberg.

Authors

Haruka, follow me on Mastodon or support me on Ko-fi