3 releases

Uses new Rust 2024

new 0.1.2 May 5, 2025
0.1.1 May 1, 2025
0.1.0 May 1, 2025

#218 in Text processing

Download history 321/week @ 2025-04-30

321 downloads per month

Custom license

27KB
537 lines

Holy carpet

A simple blog generator, customizable and written in Rust.

How to use

Initialize a new blog:
holy-carpet --init --directory DIRECTORY
--OR--
holy-carpet -i -d DIRECTORY
Initializes a new blog in DIRECTORY.

Build your blog:
holy-carpet --build --directory DIRECTORY
--OR--
holy-carpet -b -d DIRECTORY
Builds static HTML files for your blog, output in DIRECTORY/html

For further information, check the command help:
holy-carpet --help
--OR--
holy-carpet -h

Building your blog

After building your blog, you may want to add posts. To do so, first delete the example posts in DIRECTORY/posts, and add your first own post. Holy carpet uses a somewhat custom markdown format to get information about your posts. For your post to be working and visible on your index page, you need to add three lines somewhere in your post file. The date has to follow the format above (YYYY/MM/DD).:

%TITLE:Hello, world!%
%DATE:1970/01/01%
%DESCRIPTION:Hello, hi!%

I think their purpose should be obvious.

To customize your index page, edit DIRECTORY/templates/index.md. Place the %POSTS% line where you want your posts list to be.

This is heavily inspired by funderscore's "seen" blog generator

Dependencies

~11–19MB
~255K SLoC