A rocket fast, lightweight, static site generator

Installation

$ npm i @sphido/core @sphido/frontmatter @sphido/marked @sphido/meta @sphido/nunjucks

Quick Start

const globby = require('globby');
const {getPages} = require('@sphido/core');
const {save} = require('@sphido/nunjucks');

(async () => {

    // 1. get list of pages
    const pages = await getPages(
        await globby('content/**/*.md'),
        ...[
            require('@sphido/frontmatter'),
            require('@sphido/marked'),
            require('@sphido/meta'),
            {save},
        ],
    );

    // 2. save them (with default template)
    for await (const page of pages) {
        await page.save(
            page.dir.replace('content', 'public')
        );
    }

})();

Get Source Code

Source codes

• @sphido/code - most important getPage() and getPages() functions.
• @sphido/feed - generate atom feed from pages.
• @sphido/frontmatter - page extender that process front matter block inside content.
• @sphido/link - extender function link() allow create URL link to page.
• @sphido/marked - page extender that transform page.content markdown to HTML with marked.
• @sphido/meta - extender that add common properties to pages.
• @sphido/nunjucks - allow generate HTM with nunjucks templates a rich and powerful templating language for JavaScript from Mozilla.
• @sphido/pagination - allow paginate over pages.
• @sphido/sitemap - allow generate sitemap.xml from pages.
• @sphido/twemoji - transform content emoji to twemoji.

View Sphido API Docs for more information about packages.

Examples

• https://github.com/sphido/examples - more examples like JSON generator
• https://github.com/sphido/sphido.org - source of sphido.org website.