This is a static website generator, that includes support for a blog, with vanity urls, keyword tags, RSS, sitemap.xml.
Like pretty much everything made in rust, it was built to learn rust...
Note, you'll find the same repository site-gen written in Swift, this one however went way further...
it takes a .settings.json of this format...
{
"workdir": "/Users/name/Documents/Code/website/public",
"webroot": "https://website.org",
"template": "./template/template.html",
"templateindex": "./template/template-index.html",
"contenttag": "{{%%content%%}}",
"titletag": "{{%%title%%}}",
"descriptiontag" : "{{%%description%%}}",
"keywordstag": "{{%%keywords%%}}"
}
The site generator will then
- walk recursively the
workdirlooking for.md(markdown) files, - converts them to HTML
- insert them in
template - replacing the
contenttagwith the HTML - update
descriptiontagwith the contents of<x-desc>(custom valid HTML5 tag in the markdown) - same with the
keywordstagwith the contents of<x-tags>(hidden) - same with the
titletagwith the contents of<x-title> - it will do the same with the templateindex if the markdown contains (as an indicator of being the index)
This custom HTML5 tag gymnastic is to avoid having metadata json files around, or breaking the valid markdown format (like Hugo does). In retrospect, I have mixed feelings about it.
NOTE: the content will be placed in situe. So if the website places a markdown in /folder it will be /folder/index.html so that you're in control of the whole website structure and vanity urls.
The blogging system works pretty much the same, except I use <x-blog-title> instead of <x-title> to tell the generator that this is a blog post.
Blog posts will automatically have a blog class on the <body> to style the blog differently, as needed.
Additionally we parse sub for the RSS pubDate and to be sorted on the index page.
It will be included in the RSS and linked from the homepage. Note that this last part is pretty much custom to suit my own needs, but could be abstracted out further.
Cargo run
Cargo build --release
./target/release/site-gen-rust
For fun, I ran some stats. This compares the different builds. Note that all were written pretty naively. So, take those with a grain of salt. However the implementation logic is very linear and very similar...
I am surprised by the speed of the Go implementation considering how quickly I wrote all the code. It certainly was easier than the Rust's or OCaml implementation. Dart felt like the easiest to write in.
The C version could use further optimisations. The most poetic and readable is the OCaml version. The least readable is the Rust version.
Each versions have very minor differences in the output HTML, based on the native markdown library, e.g. some handle ellipsis, some don't, etc.
hyperfine --warmup 5 ./site-gen-go # ran for approx 410 iterations.
Time (mean ± σ): 3.0 ms ± 0.2 ms [User: 1.1 ms, System: 1.8 ms]
Time (mean ± σ): 4.3 ms ± 0.2 ms [User: 2.1 ms, System: 2.0 ms]
Time (mean ± σ): 4.8 ms ± 0.1 ms [User: 2.0 ms, System: 2.8 ms]
Time (mean ± σ): 6.4 ms ± 0.2 ms [User: 3.5 ms, System: 2.8 ms]
Time (mean ± σ): 21.2 ms ± 0.2 ms [User: 17.6 ms, System: 3.3 ms]
Time (mean ± σ): 30.8 ms ± 0.6 ms [User: 21.8 ms, System: 8.5 ms]
Time (mean ± σ): 30.0 ms ± 0.5 ms [User: 21.8 ms, System: 8.5 ms]