A rocket 🚀 fast, lightweight, static site generator.

Installation

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

Quick Start

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


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

	// 2. save to html with default template
	for await (const page of posts) {
		await page.save(
			page.dir.replace('packages', 'public'),
		);
	}
})();

Packages

npm i @sphido/core           # basic getPages, getPage functions
npm i @sphido/feed           # generate atom feed from pages
npm i @sphido/frontmatter    # frontmatter for pages
npm i @sphido/link           # add link() method to pages
npm i @sphido/marked         # markdown pages content
npm i @sphido/meta           # add common metadata to the pages
npm i @sphido/nunjucks       # nunjucks templates
npm i @sphido/pagination     # paginate over pages
npm i @sphido/sitemap        # generate sitemap.xml
npm i @sphido/twemoji        # add twemoji support

Examples

• https://github.com/sphido/examples/

License

MIT