Sphido logo

A rocket ๐Ÿš€ fast, ๐Ÿ’ญ lightweight, static site ๐Ÿค– generator


npm i @sphido/core @sphido/frontmatter @sphido/markdown @sphido/meta fs-extra globby

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

Create index.js

#!/usr/bin/env node --experimental-modules

import path from "path";
import globby from "globby";
import fs from "fs-extra";
import {getPages} from "@sphido/core";
import {frontmatter} from "@sphido/frontmatter";
import {meta} from "@sphido/meta";
import {markdown} from "@sphido/markdown";

(async () => {

    // 1. get list of pages

    const pages = await getPages(
        await globby('content/**/*.{md,html}'),


            // add custom page extender
            (page) => {
                page.toFile = path.join(
                    page.dir.replace('content', 'public'),

            // add custom page function
                head: function() {
                  return `<head><meta charset="UTF-8"><title>${this.title}</title></head>`

                getHtml: function () {
                    return `<!DOCTYPE html>` + 
                           `<html lang="en" dir="ltr">` + this.head() + 

    // 2. save pages

    pages.forEach(page => fs.outputFile(page.toFile, page.getHtml()))


Run script

node index.mjs