A rocket 🚀 fast, ️💭 lightweight and flexible static site 🤖 generator.

I know, another static site generator! This one is different - it's totally minimalistic. Basically, it's just two functions. The first, the getPages() function, allows you to retrieve a list of pages, and the allPages() function allows you to iterate through them.

You get a static site generator that is:

🚀 rocket fast
💭️ light-weight
🤘 no dependencies
⚡️ flexible

Installation

yarn add @sphido/core

npm i @sphido/core

Quick Start

#!/usr/bin/env node

import {dirname, join, relative} from 'node:path';
import {allPages, getPages, readFile, writeFile} from '@sphido/core';
import slugify from '@sindresorhus/slugify';
import {marked} from 'marked';

const pages = await getPages({path: 'content'}, // ... extenders
  (page) => {
    page.slug = slugify(page.name) + '.html';
    page.dir = dirname(page.path);
  });

for (const page of allPages(pages)) {
  page.output = join('public', relative('content', page.dir), page.slug);
  page.content = marked(await readFile(page.path));

  await writeFile(page.output, `<!DOCTYPE html>
  <html lang="en" dir="ltr">
  <head>
    <meta charset="UTF-8">
    <script src="https://cdn.tailwindcss.com?plugins=typography"></script>
    <title>${page.name} | Sphido Example</title>
  </head>
  <body class="prose mx-auto my-6">${page.content}</body>
  <!-- Generated by Sphido from ${page.path} -->
  </html>`);
}

Sphido requires Node 16.x and newer. To load an ES module, set "type": "module" in the package.json or use the .mjs extension.

Run script

node index.ts

Packages

@sphido/core - core functions getPages(), allPages(), readFile() and writeFile()

Page extenders

@sphido/frontmatter - frontmatter extender for page
@sphido/hashtags - process hashtags in page.content

Website components

@sphido/sitemap - generate sitemap.xml file

Examples

License

MIT