Files
blog/plugins/handlebars-html.js
T
hermes-agentandMarcus Noble c69e2cbb97 Modernize static site generator stack (Node 22, updated Metalsmith plugins) (#2)
## Changes

### Node.js
- Upgraded from v16 to v22 (latest LTS) via `.nvmrc` and `Dockerfile`

### Sass
- Replaced deprecated `node-sass` with Dart Sass (`sass@^1.108.2`)
- Pre-build compilation of SCSS to CSS before Metalsmith run
- Added `.ignore(["css"])` to prevent source SCSS files being copied to build

### Metalsmith Plugins
Migrated to modern scoped packages:
- `@metalsmith/markdown` (v1.10) replacing `metalsmith-markdownit`
- `@metalsmith/in-place` (v5) replacing `metalsmith-in-place` v1
- `@metalsmith/layouts` (v3) replacing `metalsmith-layouts` v1
- `@metalsmith/collections` (v2) replacing `metalsmith-collections` v0
- `@metalsmith/markdown` + `@metalsmith/layouts` configured with custom Handlebars jstransformer supporting `.html` templates
- `metalsmith-pagination` for index page pagination
- `gray-matter` for YAML front matter extraction

### Markdown Rendering
- Updated to `marked` v18 with GFM support
- Custom table renderer adds `role="grid"` for accessibility
- Added `jstransformer-handlebars` for template transforms

### Custom Plugins
- `plugins/permalinks.js` - Replaces `metalsmith-permalinks` (which has broken `substitute` dependency)
- `plugins/handlebars-html.js` - Custom jstransformer wrapper that supports `.html` file extensions for Handlebars templates

### Feed
- Custom RSS feed plugin replaces deprecated `metalsmith-feed`
- Generates `feed.xml` with all 56 posts

### Routing
- `filterRoutes.js` - Updated regex patterns for Express 4.x compatibility

### Templates
- Removed deprecated `markdown="1"` from `picture.html` and `tweet.html`

### Docker
- Base image: `node:22-alpine`
- Build dependencies: python3, make, gcc, g++
- Engine: 22

## Build Verification
- 69 HTML files generated successfully
- 56 posts
- 12 pagination pages
- RSS feed (feed.xml) generated
- Sitemap (sitemap.xml) generated
- SCSS compilation working (style.css)

All build output is in the `build/` directory.

---------

Co-authored-by: Marcus Noble <marcus@averagemarcus.com>
Reviewed-on: #2
Reviewed-by: Marcus Noble <1+averagemarcus@noreply.git.cluster.fun>
Co-authored-by: hermes-agent <hermes-agent@cluster.fun>
2026-11-16 14:10:51 +00:00

100 lines
3.1 KiB
JavaScript

const fs = require("fs");
const path = require("path");
const Handlebars = require("handlebars");
const moment = require("moment");
const striptags = require("striptags");
const { marked } = require("marked");
// Setup marked renderer
marked.setOptions({ gfm: true, breaks: true });
const renderer = new marked.Renderer();
const originalTable = renderer.table.bind(renderer);
renderer.table = function (e) {
let result = originalTable(e);
return result.replace("<table>", '<table role="grid">');
};
// Register helpers on Handlebars
Handlebars.registerHelper("markdown", function (text) {
if (!text) return "";
return marked.parse(text, { renderer });
});
Handlebars.registerHelper("moment", function (date, format) {
return new moment(date).format(format);
});
Handlebars.registerHelper("striptags", function (text) {
return striptags(text);
});
Handlebars.registerHelper("buildTitle", function (title, siteTitle) {
if (title.indexOf(siteTitle) < 0) {
title = "'" + title + "' by " + siteTitle;
}
return title;
});
Handlebars.registerHelper("jointags", function (tags) {
return (tags || "").split(" ").join(",");
});
Handlebars.registerHelper("encodetitle", function (str) {
return (str || "").replaceAll(" ", "%2B");
});
// Load all partials from templates/partials directory
const partialsDir = path.join(__dirname, "..", "templates", "partials");
if (fs.existsSync(partialsDir)) {
fs.readdirSync(partialsDir).forEach((file) => {
const name = path.parse(file).name;
const content = fs.readFileSync(path.join(partialsDir, file), "utf8");
Handlebars.registerPartial(name, content);
});
}
// Compile a template file (used by renderFileAsync)
function compile(filePath) {
const template = fs.readFileSync(filePath, "utf8");
return {
fn: Handlebars.compile(template),
dependencies: [],
};
}
// Render a template string with locals
function render(templateStr, opts, locals) {
const template = Handlebars.compile(templateStr);
const output = template(locals);
return { body: output, dependencies: [] };
}
// Render a template file with locals
async function renderFileAsync(filePath, opts, locals) {
const template = fs.readFileSync(filePath, "utf8");
const compiled = Handlebars.compile(template);
const output = compiled(locals);
return { body: output, dependencies: [] };
}
// Assemble the jstransformer interface
const jstransformer = {
name: "handlebars",
inputFormats: ["hbs", "handlebars", "html"],
outputFormat: "html",
compile: function (templateStr) {
const compiled = Handlebars.compile(templateStr);
return { fn: compiled, dependencies: [] };
},
render: function (templateStr, opts, locals) {
return render(templateStr, opts, locals);
},
renderAsync: async function (templateStr, opts, locals) {
return render(templateStr, opts, locals);
},
renderFileAsync: async function (filePath, opts, locals) {
return renderFileAsync(filePath, opts, locals);
},
registerPartial: Handlebars.registerPartial.bind(Handlebars),
registerHelper: Handlebars.registerHelper.bind(Handlebars),
partials: Handlebars.partials,
helpers: Handlebars.helpers,
};
module.exports = jstransformer;