Repository files navigation

A bare-bones, zero-configurationstatic site generator that deliberately hasno features, an experiment in radical simplicity. Essentially a tiny, elegant glue betweenEJS templates andMarkdown with freeform structure (enabling incremental adoption) and convenient defaults, written in under 120 lines of JavaScript.

• Example
• Documentation
  • Getting started
  • Data files
  • Templates
  • Command line
  • Node.js API
• FAQ

# source directory├── posts│   ├── 01.md│   ├── 02.md│   └── item.ejs├── _header.ejs└── index.ejs# output├── posts│   ├── 01.html│   └── 02.html└── index.html

An example template:

<%-include('_header.ejs')%><%for (const [name, {date,title}]ofObject.entries(posts)) {%><h3><%=date.toDateString()%>:<a href="posts/<%= name %>.html"><%= title%></a></h3><% }%>

Browse thefull example and see thegenerated website.

npx tinyjam source_dir output_dir

Tinyjam doesn't impose any folder structure, processing any data files (*.md and*.yml) and templates (*.ejs) it encounters and copying over anything else.

All*.md and*.yml files inside the working directory are interpreted asdata, available for any templates all at once as JavaScript objects. For example, given the following folder structure:

├── posts│   ├── 01.md│   ├── 02.md├── data.yml└── about.md

A template in this folder will have the contents available as:

posts:{"01":{title:"First post",date:newDate("2020-02-20"),body:"Hello world"},"02":{title:"Second post",date:newDate("2020-02-21"),body:"Hello there"}},data:{author:"Vladimir Agafonkin"},about:{body:"This is an awesome blog about me."}

Markdown is rendered according to theGitHub Flavored Markdown specification.

Tinyjam uses EJS (throughyeahjs, a fast EJS subset), a templating system where you can use plain JavaScript, so it's both powerful and easy to learn. All*.ejs files it encounters are rendered with the collected data in the following way:

• <filename>.ejs files are rendered as<filename>.html.
• item.ejs has a special meaning: alldata files in the same folder (e.g.<filename>.md) are rendered with this template as<filename>.html with the corresponding file's data.
• Templates starting with_ (e.g._header.ejs) are skipped (to be used as EJS includes).
• Templates are rendered ashtml by default, but you can use other extensions, e.g.main.css.ejs will be rendered asmain.css.

In addition to the collected data, templates have access to the following properties:

• rootPath is a relative path to the root of the project — useful as a prefix for links in includes as they may be used on different nesting levels (e.g.<%= rootPath %>/index.css).
• root references all of the project's data, which is useful for accessing data in includes or outside of the current template's folder.

Install with NPM to usetinyjam as a CLI:npm install -g tinyjam. Usage:

tinyjam source_dir [output_dir] [--breaks] [--smartypants] [--silent]

• --breaks: Add single line breaks as<br> in Markdown.
• --smartypants: Convert quotes, dashes and ellipses in Markdown to typographic equivalents.
• --silent: Run silently (unless there's an error).

Ifoutput_dir is not provided, it's assumed equal tosource_dir. This is useful for incrementally converting static sites without changing deployment folders.

importtinyjamfrom'tinyjam';tinyjam(sourceDir,outputDir,{log:false,// log the progress (like in the CLI)breaks:false,// Markdown: add single line breaks (like in GitHub comments)smartypants:false,// Markdown: convert quotes, dashes and ellipses to typographic equivalentshighlight:null// a code highlighting function: (code, lang) => html});

Note that the project only supports Node v12.17+.

I wanted to add some templating to my personal static websites to make them easier to maintain (e.g.my band's album page, which is pure HTML/CSS/JS), but never found a static site generator that would be simple and unobtrusive enough for my liking.

A tool I envisioned would not involve meticulous configuration, special folder structure, reading through hundreds of documentation pages, bringing in a ton of dependencies, or making you learn a new language. At the same time, it would be flexible enough to make multilingual websites without plugins and convoluted setup.

Ideally, I would just rename somehtml files toejs, move some content to Markdown files, add light templating and be done with it. So I decided to build my own minimal tool for this, but will be happy if anyone else finds it useful.

Sorry — probably not, unless it fits the concept of a minimal, zero-configuration tool.

Pretty fast. I didn't see a point in benchmarking because most of the time is spent parsing Markdown/YAML and rendering EJS anyway, but corresponding dependencies (marked,js-yaml,yeahjs) are very well optimized.

EJS is also an extremely simple, minimal system, and it allows you to use plain JavaScript for templates, making it pretty powerful with almost no learning curve. To make it even faster, I crafted my own implementation (yeahjs). No plans to support other template engines.

There's no need for all that in a static website. If you do have a case for it, you'll need a different tool.

Tinyjam gives you freedom to approach this in many different ways, but here's an example:

en.ejs:<%-include('_content.ejs', {lang:'en'})%>fr.ejs:<%-include('_content.ejs', {lang:'fr'})%>_content.ejs:<%= content[locals.lang].body%> (use either content/en.md or content/fr.md)

At the moment, you can't. It's not a great UI pattern anyway — make an archive page with links to all content instead.

Do all the preprocessing in the source directory prior to runningtinyjam.

Here's an example using thetinyjam API withhighlight.js:

importtinyjamfrom'tinyjam';import{highlight}from'highlight.js';tinyjam(sourceDir,outputDir,{highlight:(code,lang)=>highlight(lang,code).value});