A rocket
π rocket fast- οΈ
π lightweight π€ no dependenciesβ‘οΈ flexible
Installation
$ yarn add @sphido/core
or
$ npm i @sphido/core
Quick Start
#!/usr/bin/env node
import {dirname, relative, join} from 'node:path';
import {getPages, allPages, 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>
`);
}
Packages
@sphido/core
- core functionsgetPages()
,allPages()
,readFile()
andwriteFile()
Page extenders
@sphido/frontmatter
- frontmatter extender forpage
@sphido/hashtags
- process hashtags inpage.content
Website components
@sphido/sitemap
- generatesitemap.xml
file
Examples
License
MIT