Skip to content
Jérôme Beau edited this page Nov 16, 2022 · 3 revisions

Ssg is Static Site Generation API main class, which is responsible for executing Steps.

Typical usage of Ssg is:

  1. create a new instance with a SsgConfig (which consist basically in a {outDir: string})
  2. add Steps to it (mind the order)
  3. start the generation with a Context

For instance:

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

const config: SsgConfig = {outDir: "out"}
const context = new SsgContextImpl("fr", {})

new Ssg(config)
  .add(new ContentStep(contentConfigs, outputFunc))
  .add(dir1SubdirectoriesStep)
  .add(dir2SubdirectoriesStep)
  .add(...anArrayOfSteps)
  .add(new CopyStep(copiesToDo))
  .start(context)

Clone this wiki locally