@static-pages/core
Advanced tools
Readme
Yet another static pages generator? Yes! Because I browsed the whole jamstack scene, but could not find one which
And because I wrote a ton of custom static generators before; I tought I can improve the concepts to a point where its (hopefully) useful for others.
This project is structured as a toolkit split to many packages, published under the @static-pages namespace on NPM. In most cases you should not use this core package directly, but the @static-pages/starter is a good point to begin with.
This project targets small and medium sized websites. The rendering process tries to be as fast as possible so its also useful when you need performance.
import fs from 'node:fs';
import path from 'node:path';
import staticPages from '@static-pages/core';
staticPages({
from: [
{ title: 'About', url: 'about', content: 'About us content' },
{ title: 'Privacy', url: 'privacy', content: 'Privacy content' },
],
controller(data) {
data.now = new Date().toJSON();
return data;
},
to({ title, url, content, now }) {
const fileName = path.join('public', url + '.html');
const fileContent = `<html><body><h1>${title}</h1><p>${content}</p><p>generated: ${now}</p></body></html>`;
fs.mkdirSync(path.dirname(fileName), { recursive: true });
fs.writeFileSync(fileName, fileContent);
}
})
.catch(error => {
console.error('Error:', error);
console.error(error.stack);
});
The usage example above does a rough presentation only and not considered to be a production ready snippet. Helpers to read and write documents are provided in separate packages, eg. @static-pages/io.
For detailed information, visit the project page.
staticPages(...routes: Route[]): Promise<void>Each route consists of a from, to and a controller property matching the definition below.
interface Route<F, T> {
from: Iterable<F> | AsyncIterable<F>;
to(data: T): void | Promise<void>;
controller?(data: F): undefined | T | Iterable<T> | AsyncIterable<T> | Promise<undefined | T | Iterable<T> | AsyncIterable<T>>;
}
The controller may return with multiple documents, each will be rendered as a separate page. Alternatively it may return undefined to prevent the rendering of the current document.
Create an issue describing your needs! If it fits the scope of the project I will implement it.
FAQs
General purpose static pages renderer.
The npm package @static-pages/core receives a total of 27 weekly downloads. As such, @static-pages/core popularity was classified as not popular.
We found that @static-pages/core demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Git dependencies in open source packages can introduce significant risks, including lack of version control, stability issues, dependency drift, and difficulty in auditing, making them potential targets for supply chain attacks.
Security News
Node.js has added experimental support for TypeScript, a move that highlights the growing importance of TypeScript in modern development.
Product
Check out what's new at Socket with our Product Changelog. It tracks all public-facing updates, improvements, and fixes so you can take full advantage of our features.