@dantenl/umejs
v1.2.1
Published
Untitled Markdown Engine
Maintainers
dantenlReadme
ume.js
umejs (short for unnamed markdown engine) is a small little project that you can slot into Express to automagically convert Markdown files into a static website. It's easy to set up for any existing project or to create a new project, for example a blog. It's quite small, but at the same time very flexible.
If you want to see a site generated by ume, check out the documentation.
Quickstart
Simply download it from npm and it's ready in your project!
npm install @dantenl/umejsLet's set up a sample website for ume! Here's an example for your main.js file in Express:
// main.js
const ume = require('@dantenl/umejs');
const express = require('express');
const path = require('path');
const app = express();
const PORT = 3000;
const blogMiddleware = ume({
contentDir: path.join(__dirname, 'content'), // where .md files live
templatePath: path.join(__dirname, 'templates', 'layout.ume.html'), // main layout
// there are more config options, check out the docs!
});
// initialise the middleware
app.use('/*slug', blogMiddleware);
// start the server
app.listen(PORT, () => {
console.log(`Server running at http://localhost:${PORT}`);
});This is all you ned for your main JS file! Now we need a simple template:
<!-- templates/layout.ume.html -->
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>{title}</title>
</head>
<body>
{_BODY}
</body>
</html>Now we need to create a simple article!
---
# content/example.md
title: example!
date: 2026-06-29
---
# hey there!All you need to do now is start up your project and open your browser to http://localhost:3000/hello and your content should be visible!
This is just the tip of the iceberg though, ume is quite a lot more advanced than this! Including stuff like partials and custom variables!