ssg-api

ssg-api

TypeScript API to generate output files from input files.

It can be used to generate:

• a static website from HTML templates (but those templates can include client-side JavaScript and CSS of course).
• (and/or) other files such as configuration files (for instance converting an .htaccess file to a netlify.toml file)

To install ssg-api as a project dependency:

npm install --save ssg-api

Then import the required types to implement your own SSG code:

import {Ssg, SsgContextImpl, SsgConfig} from "ssg-api"

const config: SsgConfig = {outDir: "out"}
const ssg = new Ssg(config)
  .add(firstStep)
  .add(nextStep)

const context = new SsgContextImpl("fr", {})
try {
  const result = await ssg.start(context)
  console.log("Completed", result)
} catch (e) {
  console.error(err, context.inputFile.name, "=>", context.outputFile.name)
}

Steps can do anything. You can implement your owns, but there are predefined ones. Check the documentation for more.

Changelog

[1.2.12] - 2022-12-03

Changed

• Make DomReplaceCommand.postExecute() async.