sesame

Sesame 🌱

A library of tools for building smaller, greener, less resource intensive and more accessible websites inspired by Low Tech Magazine. A few basic example exists inside ./examples.

• Sesame contains the suite of tools, including transformations over markdown (ToC generation), responsive image generation, HTML output etc.
• Current_sesame takes those tools along with the rest of the OCurrent ecosystem and produces more tools for writing incremental site generators with hot-reloading if you want it!

API Documentation

The main idea

Sesame is built on the idea of Collections -- these are groups of documents that share common metadata. They should be formatted using the Jekyll Format with yaml frontmatter separating the body from the metadata.

Collections & Metadata

You must provide an interface corresponding to Meta in order to build a collection. Luckily tools exist that make this incredibly simple.

module M = struct 
  type t = { title: string; authors : string list} [@@deriving yaml]
end 

Which corresponds to the markdown file:

---
title: My first blog post
authors: 
  - Alice 
---

Once upon a time...

From there it's up to you how the HTML is generated. Why not have a read of:

• The more complete Sesame tutorial.
• The OCurrent-powered Site generator tutorial.
• The examples directory is also a good place to start.