Antwerp

Overview:

Antwerp was a closed-source build program for logicalbranch.github.io. It was ported from Node.js & Pug to Rust & Tera and is now an open-source framework for building static blogs. It's available on crates.io as Antwerp.

Antwerp takes specified resources and copies assets & directories, compiles SCSS stylesheets, and renders Tera templates to generate a static website in a user-defined folder, it also supports multiple builds using seperate instances.

Demonstration:

The following Antwerp.toml config file (version 0.2.3) was used to generate malekaia.github.io:

```toml urlroot = 'https://malekaia.github.io' urlpost = '%urlroot/articles/%category/%slug.html' pathrender = 'articles/%category/%slug.html' dirresources = './public/' diroutput = './dist/malekaia.github.io/' dirtemplates = './public/**/*.tera' dirposts = './public/articles//.tera' verbose = true clean = true preserve = false

[header] image="/images/manuel-cosentino:n--CMLApjfI-unsplash.jpg"

[author] name="Malekai" image='/images/favicon.png' githuburl='https://github.com/Malekaia' githubusername='@Malekaia' ```

Using the following build method (available at example/main.rs):

```rust use antwerp::{Antwerp, Post}; use tera::Context;

pub fn build() { // Create a new build instance let build: Antwerp = Antwerp::new();

// Create the post list let postlist: Vec = build.postlist(| unsorted: Vec | -> Vec { // sort into vec[vec[tutorial], vec[project], vec[opinion], vec[misc], vec[guide]] let mut sorted: Vec> = vec![vec![], vec![], vec![], vec![], vec![]]; for post in unsorted { match &*post.genre { "Tutorial" => sorted[0].push(post), "Project" => sorted[1].push(post), "Opinion" => sorted[2].push(post), "Misc" => sorted[3].push(post), "Guide" => sorted[4].push(post), unknowngenre @ _ => panic!("Ignore (unknown genre): {} in {}", unknowngenre, post.pathtemplate) } } // vec[...tutorial, ...project, ...opinion, ...misc, ...guide] for genre in &mut sorted { genre.sortbykey(| post | post.template.len()); genre.reverse(); } sorted.intoiter().flatten().collect::>() });

// Copy directories build.folder("images//", r".(png|jpg)$", false); build.folder("scripts/vendor/.js", r".js$", false); build.folder("scripts/.js", r".js$", true); build.folder("styles/vendor//", r".(css|woff|woff2)$", false);

// Compile SCSS assets build.scss("styles/app.scss", "styles/app.css"); build.scss("styles/http.scss", "styles/http.css");

// Build "/404.html" template build.route("404.tera", "404.html", &build.empty_context);

// Build HTTP 410 (deleted) templates for output in [ "about/index.html", "contact/index.html", "img/index.html", "info/index.html", "articles/jQuery/howtomodifythejqueryglobalwithoutmodifyingjquery/index.html", "articles/jQuery/howtoscrolltoanelementonclick/index.html", "articles/Node.js/braceexpansioninshelljs/index.html", "articles/WebDevelopment/howtosetupadevelopmentserverusingexpress/index.html", "articles/WebDevelopment/howtosetupadevelopmentserverusingflask/index.html" ] { build.route("410.tera", output, &build.empty_context); }

// Build HTTP 301 (moved) templates for [output, redirect] in [ ["articles/Bootstrap/howtochangethedefaultfontinbootstrap/index.html", "/articles/CSS/how-to-change-the-default-font-in-bootstrap.html"], ["articles/Git/howtoavoidoverusingthegitkeyword/index.html", "/articles/Git/how-to-avoid-retyping-the-git-keyword.html"], ["articles/Go/globbingingo/index.html", "/articles/Go Lang/globbing-in-go.html"], ["articles/HTML/howtoopenhtmllinksinnewtabs/index.html", "/articles/HTML/how-to-open-html-links-in-new-tabs.html"], ["articles/Node.js/environmentdetectioninjavascript/index.html", "/articles/JavaScript/environment-detection-in-javascript.html"], ["articles/Perl/howtounzipanarchiveusingperl/index.html", "/articles/Perl/how-to-call-a-subprocess-in-perl.html"], ["articles/Pip/anintroductiontothepippackagemanager/index.html", "/articles/Python/an-introduction-to-the-pip-package-manager.html"], ["articles/SASS/howtoextendparentselectorsinsass/index.html", "/articles/CSS/how-to-extend-parent-selectors-in-sass.html"], ["articles/WebDevelopment/howtocreateadevelopmentserverusinghttpserver/index.html", "/articles/Python/how-to-create-a-development-server-using-http-server.html"] ] { build.route("301.tera", output, &{ let mut context: Context = Context::new(); context.insert("redirect", redirect); context }); }

// Build "/index.html" template build.route("index.tera", "index.html", &{ let mut context: Context = Context::new(); // FIXME: change names context.insert("articles", &postlist); context.insert("templatename", "index"); context.insert("headerimage", "nasa-yZygONrUBe8-unsplash.jpg"); context.insert("headercredits", "Manuel Cosentino"); context.insert("githuburl", &build.config.author.githuburl); context.insert("githubusername", &build.config.author.githubusername); context });

// Build "/articles/index.html" template build.route("articles/index.tera", "articles/index.html", &build.empty_context);

// Build post templates for post in &postlist { build.route("articles/article.tera", &post.pathrender, &{ let mut context: Context = Context::new(); context.insert("articles", &postlist); context.insert("article", &post); context.insert("template", &build.renderstring(&post.template, &build.emptycontext)); context.insert("templatename", "article"); context }); } } ```

License:

The source code included in this repository is distributed for free, under the MIT Licence. For the full license, see LICENSE.md.